Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Payment API - Add description of order_reference parameter #19449

Merged
merged 1 commit into from
Jan 27, 2021

Conversation

mattwire
Copy link
Contributor

Overview

The order_reference parameter has been supported since 5.27 but is missing from the spec.

Before

Param missing

After

Param added

Technical Details

Comments

Just makes this parameter a little bit more discoverable

@civibot
Copy link

civibot bot commented Jan 27, 2021

(Standard links)

@civibot civibot bot added the master label Jan 27, 2021
@totten totten changed the title NFC Add order_reference to API3 payment.get spec Payment API - Add description of order_reference parameter Jan 27, 2021
@totten
Copy link
Member

totten commented Jan 27, 2021

I checked the metadata in both CLI and API Explorer. Looks good on all counts (r-explain, r-user, r-doc, r-run, r-tech, r-code, r-maint, r-test). Merging.

Tangential observation: This doesn't reflect on the merits of this PR, but maybe it's worth saying out loud... there are several fields (order_reference, trxn_id, trxn_date, etal) which are defined in both Payment.create and Payment.get. They do match in the most important characteristics (e.g title, type), but there are also a bunch of random-seeming discrepancies in the metadata (e.g. when do size/maxlength matter? e.g. when do table_name/bao matter? should it be a little DRYer?). It might merit a closer look sometime.... (Again, it doesn't affect this PR. The PR is a functional improvement and is consistent with the code being patched.)

@totten totten merged commit 7a31fd3 into civicrm:master Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants