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

Maintain order in which paths are added to spec #87

Merged

Conversation

@ranjanashish
Copy link
Contributor

commented Aug 9, 2016

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}/uploadImage was 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.

swagger-petstore

Currently, the generated spec (via APISpec.to_dict) does not maintain the order in which paths were added (via APISpec.add_path) to APISpec.

@sloria sloria merged commit b1a77cf into marshmallow-code:dev Aug 15, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@sloria

This comment has been minimized.

Copy link
Member

commented Aug 15, 2016

Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.