Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Correct payment_failed_url docs to reflect the deployed fallback behavior

Aperta
  • Qualcosa non va?
#62 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
openapi
Ambito
api, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
MDX
Stelle
2
Fork
0
Merge medio
6h 4m
PR unite (30g)
13

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di NextCommerceCo/developer-docs

Tutte le issue di NextCommerceCo/developer-docs

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.