Maintain order in which paths are added to spec#87
Merged
sloria merged 1 commit intomarshmallow-code:devfrom Aug 15, 2016
Merged
Maintain order in which paths are added to spec#87sloria merged 1 commit intomarshmallow-code:devfrom
sloria merged 1 commit intomarshmallow-code:devfrom
Conversation
Member
|
Thanks again! |
This was referenced Mar 29, 2018
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Providing API documentation in a particular order, in general, makes the API design more obvious and API usage more easier for the users.
For example, in petstore documentation, what if the API
/pet/{petId}/uploadImagewas mentioned before the API for adding a new pet to the store. In a quick glance, the end user would not be so happy to see the jumbled APIs.Currently, the generated spec (via
APISpec.to_dict) does not maintain the order in which paths were added (viaAPISpec.add_path) toAPISpec.