Skip to content

Add SLA information into spec #51

Closed

Description

@fehguy

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.

Activity

  1. eddieajau commented on May 7, 2014

    @eddieajau

    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

  2. added a commit that references this issue on Sep 8, 2014
  3. webron commented on Sep 19, 2014

    @webron
    Member

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions