Skip to content

Fix documented examples that do not match the package API - #4

Merged
hegedustibor merged 1 commit into
mainfrom
fix/docs-examples
Oct 18, 2026
Merged

hegedustibor merged 1 commit into
mainfrom
fix/docs-examples

Conversation

@hegedustibor

Copy link
Copy Markdown
Contributor

Mi változott

A README, a példák és a Boost skill több kódpéldája nem a csomag valódi API-ját használta. Ezeket javítottam:

  • FinishRequest: a kötelező amount és originalTotal bekerült a példákba. A finish() FinishRequest-et vár; a query-refund-cancel példák (angolul és magyarul) eddig nevesített argumentumokkal hívták.
  • RefundRequest: a paraméter neve amount, nem refundTotal.
  • IPN: az esemény az üzenetet a $event->ipn property-ben adja, nem a $event->ipnMessage-ben, és a paymentMethod string.
  • A Boost skill PaymentRequest-példáiból hiányzott a kötelező total és language, és a tax számként adható meg.
  • Az ErrorCode enumban 351 kód van; a README eddig 358+-t írt.

Ellenőrzés

  • Csak dokumentáció változott, a kód és a tesztek nem.
  • Reflection-alapú szkripttel ellenőriztem, hogy a dokumentáció minden new <Dto>(...) hívása és szolgáltatáshívása létező, kötelező paramétereket használ-e.
    • Ezen a branchen csak a kártyatárolás, a recurring és az Apple Pay példái maradtak hibásak; ezeket a kérés-mezőket javító PR igazítja.
    • A két PR helyben próbamerge-elve ütközés nélkül egyesül, együtt minden példa hibátlan, és a 106 teszt zöld.

Megjegyzések a review-hoz

  • A kérés-mezőket javító PR-rel együtt érdemes beolvasztani; bármelyik sorrendben ütközés nélkül egyesülnek.

- FinishRequest takes amount and originalTotal, RefundRequest takes amount
- finish() takes a FinishRequest instead of named arguments
- IPN events carry the message as $event->ipn; paymentMethod is a string
- Complete the PaymentRequest examples of the Boost skill (total, language)
@hegedustibor
hegedustibor merged commit 187720d into main Oct 18, 2026
24 checks passed
@hegedustibor
hegedustibor deleted the fix/docs-examples branch October 18, 2026 08:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant