Improve endpoint description of some API endpoints #3509
Merged
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
reviewed
Feb 7, 2020
api/openapi/api.oas2.yml
Outdated
| @@ -1030,7 +1033,7 @@ paths: | |||
| name: body | |||
| schema: | |||
| $ref: '#/definitions/address-book-input' | |||
| description: Updates a user's address book. | |||
| description: "Updates a user's address book.\n\n**Note**: if the passed `id` matches an existing `address` a new `Spree::Address` record will be created and the matched `address` `archived` on `Spree::UserAddress`. For a similar logic, if the passed `id` matches an existing `address` which is in `archived` state, the `Spree::UserAddress` record will be restored: `archived: false`. \n\nSee `user_address_book.rb` for further information." | |||
There was a problem hiding this comment.
Why not using |- as well here?
There was a problem hiding this comment.
Hey @kennyadsl,
fixed that description! https://github.com/solidusio/solidus/pull/3509/files#diff-a84e9b384a854939d2dc44eb24497283R1037
Now it is consistent with the rest of the text.
faisal-maqbool-brainx
approved these changes
Feb 7, 2020
This commit provides some context on how the address book logic works when managing user addresses.
Being Spree::CheckoutController a custom controller with not resource, it may not be clear what `checkout_id` is.
One could not expect to advance the order state machine or to have a 422 response.
Documentation should warn on the deprecation of the method and provide an alternative.
Explain that `id` paramenter is the coupon code
Better describe how the action only affect the classification position
SamuelMartini
force-pushed
the
SamuelMartini/open_api_documentation_notes
branch
from
cee4809 to
c41339a
Compare
spaghetticode
approved these changes
Feb 7, 2020
kennyadsl
changed the title
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
This pr has commits meant to make some endpoint of the api doc clearer.
Checklist: