Skip to content

Add SLA information into spec #51

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
fehguy opened this issue Apr 29, 2014 · 2 comments
Closed

Add SLA information into spec #51

fehguy opened this issue Apr 29, 2014 · 2 comments

Comments

@fehguy
Copy link
Contributor

fehguy commented Apr 29, 2014

Many API providers are looking to add more vendor-specific metadata into the spec--one is adding information about SLAs, response time, request limits, etc.

@eddieajau
Copy link

What if we made a generic specification for custom information? Custom information could be denoted by an "x-" prefix, for example "x-sla". The swagger client could then allow some kind of simple plugin architecture to support how to render/validate such custom fields. This could have a few advantages, not least of which is the ability to road-test new schema before it's included in the concrete specification. It would also allow people to define their own (adhoc) "x-meta" properties which would never form part of the official spec, but at least clients could be aware of the "x" properties.

My 2c

fehguy added a commit that referenced this issue Sep 8, 2014
@webron
Copy link
Member

webron commented Sep 19, 2014

For Swagger 2.0, vendor extensions in the format of "x-" as proposed were included and can be used to specify these things.
In the future, if specific extensions are commonly used, we may include them inherently in the spec.

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

No branches or pull requests

3 participants