-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
Comments
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 |
For Swagger 2.0, vendor extensions in the format of "x-" as proposed were included and can be used to specify these things. |
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.
The text was updated successfully, but these errors were encountered: