Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Correct payment_failed_url docs to reflect the deployed fallback behavior

Đang mở
  • Có gì không ổn?
#62 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
68/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
openapi
Lĩnh vực
api, documentation

Hướng nghiên cứu

Start with the Campaign Cart API guide and campaigns/v1.yaml, checking the create-order example, payment-failure callout, decline-flow explanation, and generated reference. Confirm the event-source fallback semantics with the implementation owner, then reconcile the guide and schema while keeping payment_failed_url optional; done means all public descriptions match the verified fallback order.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

The Campaign Cart API guide says an omitted payment_failed_url is accepted only when the request includes HTTP Referer, and otherwise order creation fails. That describes superseded behavior. Engineering confirmed deployment of additional fallbacks on 2026-06-25; a read-only check of the current implementation on 2026-09-21 confirms the fallback resolver remains present.

Affected public surfaces:

  • Campaign Cart API guide: the create-order example comment, “Send a Payment Failure URL” callout, and decline-flow explanation.
  • Campaigns OpenAPI specification: CreateOrder.payment_failed_url has only a generic redirect description and does not explain fallback behavior.

Please reconcile the guide and schema with the current API behavior:

  • Keep explicitly sending a suitable failure URL as the recommended integration practice.
  • Remove the claim that omission of both the field and Referer necessarily rejects the order.
  • Document the verified fallback order: explicit payment_failed_url, then Referer, then the campaign page URL header / available event-source fallback, then the origin of success_url. Confirm the precise event-source semantics with the implementation owner rather than describing it loosely as the shopper’s last page view.
  • Keep the field optional in the OpenAPI schema; do not add the obsolete conditional requirement or make it unconditionally required.
  • Check the example, callouts, and generated reference agree.

This is a documentation correction request, not a request to change API behavior. Historical documentation work: #44. This issue intentionally contains no merchant records or internal implementation excerpts.

Ngôn ngữ chính
MDX
Star
2
Fork
0
Merge trung bình
6 giờ 4 phút
Pull request đã merge (30 ngày)
13

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của NextCommerceCo/developer-docs

Tất cả issue của NextCommerceCo/developer-docs

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.