Skip to content

shared model support, resource overview support #35

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

Closed
wants to merge 4 commits into from

Conversation

andycmaj
Copy link

@andycmaj andycmaj commented Jun 6, 2013

Changes

  1. rename operation.errorResponses -> operation.statusCodes.
    • Better indicate that people can use this property to represent all status codes returned from an operation
    • Will break swagger-ui without incorporating accompanying change in related pull request.
  2. add shared model support
    • Allows definition in one file of shared models that can be referenced from many resources. Avoid having to copy and paste model definitions between resource definitions
  3. add resource overviews: allows general documentation overview for an entire resource.

These changes will enable the improvements in the Swagger client. In order to display in swagger-ui, see accompanying pull request in swagger-ui.

See example here: http://andycmaj.github.io/swagger-sandbox.

@jwyuen
Copy link

jwyuen commented May 20, 2014

Bump! Would really like to see this implemented for DRY purposes.

@andycmaj
Copy link
Author

Yes... so would I!

@fehguy
Copy link
Contributor

fehguy commented Jul 11, 2014

Howdy, this is an old PR and much of the DRY work has gone into the 2.0 spec for swagger. If you'd like to get involved in that, please see here:

http://swagger.wordnik.com

We can't change the 1.2 spec without breaking a bunch of clients & tooling. So 2.0 is the chance for improved spec design.

@fehguy fehguy closed this Jul 11, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants