-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Fix Request Bodies in API Documentation #4066
Merged
kennyadsl
merged 21 commits into
solidusio:master
from
nebulab:kennyadsl/fix-api-documentation-inputs
May 28, 2021
Merged
Fix Request Bodies in API Documentation #4066
kennyadsl
merged 21 commits into
solidusio:master
from
nebulab:kennyadsl/fix-api-documentation-inputs
May 28, 2021
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kennyadsl
added
changelog:solidus_api
Changes to the solidus_api gem
Documentation
labels
May 17, 2021
Starting with Solidus 3.0, we no longer accept the coupon_code attribute to be passed along with the other order's attributes. There's a separate endpoint for applying a coupon code via API: POST /orders/{order_number}/coupon_codes
gmacdougall
approved these changes
May 27, 2021
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 trust that you did this right.
spaghetticode
approved these changes
May 27, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As raised in #4058 and #3983, we are documenting all our
POST
/PUT
/PATCH
API endpoints wrongly.We need to wrap the JSON of the request body with the object name that we are trying to create/edit. This is a example of the correct format, that we will have after this PR is merged:
But we are currently documenting all the endpoints to be used as:
Enpoints Fixed:
How to test this PR's result:
Create a new project in Stoplight Studio, copy/paste the resulting oas.yml file, which should be available here and watch the preview for the result.
Checklist: