-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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
Reference for checkoutAgreement GraphQl query #4943
Reference for checkoutAgreement GraphQl query #4943
Conversation
An admin must run tests on this PR before it can be merged. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tested locally and works fine. I can approve this PR technically
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've confirmed that checkoutAgreements
has been merged into 2.3.3, so I'm ready to merge this PR, pending some changes.
@@ -0,0 +1,71 @@ | |||
--- | |||
group: graphql | |||
title: Directory endpoint |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
title: Directory endpoint | |
title: checkoutAgreements query |
--- | ||
|
||
To retrieve enabled checkout agreements. The query will always return an empty array when | ||
`checkout/options/enable_agreements` is disabled. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
`checkout/options/enable_agreements` is disabled. | |
the **Enable Terms and Conditions** option is set to **No**. (The config path is `checkout/options/enable_agreements`.) |
contributor_link: https://www.somethingdigital.com/ | ||
--- | ||
|
||
To retrieve enabled checkout agreements. The query will always return an empty array when |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To retrieve enabled checkout agreements. The query will always return an empty array when | |
The `checkoutAgreements` query retrieves checkout agreements. The query will always return an empty array when |
- AUTO | ||
- MANUAL | ||
|
||
#### Syntax |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### Syntax | |
## Syntax |
`is_html` | Boolean | Is Checkout Agreement content in HTML format | ||
`mode` | [CheckoutAgreementMode](#checkoutAgreementMode) | An array of regions within a particular country | ||
|
||
### CheckoutAgreementMode enumerable {#checkoutAgreementMode} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delete this section
@pmclain For 2.3.3, I'm getting rid of all "XYZ endpoint" topics. Instead, I'll document each query and mutation separately. I've barely begun this process, and I haven't created any query docs, but you can see the first of the mutations here: I'd like each topic to have this layout:
If you would move the CheckoutAgreement attributes section to the bottom, I'll be ready to merge this PR. (I'll move the topic and add navigation later.) |
running tests |
Hi @pmclain, thank you for your contribution! |
Thanks @pmclain |
Purpose of this pull request
Reference for checkoutAgreement GraphQl query
Fixes magento/graphql-ce#767
Links to Magento source code
https://github.com/magento/graphql-ce/blob/c3040e682d56964b78c6e7a29388bea6c1a34c85/app/code/Magento/CheckoutAgreementsGraphQl/etc/schema.graphqls#L4-L21
whatsnew
Added the checkoutAgreements query topic to the GraphQL Developer Guide.