Skip to content

Instantly share code, notes, and snippets.

@matt212

matt212/sample.yaml

Created January 31, 2019 20:20
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save matt212/97b996a8f9e98caac8afaf83d6f427e2 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save matt212/97b996a8f9e98caac8afaf83d6f427e2 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. matt212 created this gist Jan 31, 2019.
    211 changes: 211 additions & 0 deletions sample.yaml
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,211 @@
    swagger: "2.0"
    info:
    description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
    version: "1.0.0"
    title: "Swagger Petstore"
    termsOfService: "http://swagger.io/terms/"
    contact:
    email: "apiteam@swagger.io"
    license:
    name: "Apache 2.0"
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
    host: "petstore.swagger.io"
    basePath: "/v2"
    tags:
    - name: "pet"
    description: "Everything about your Pets"
    externalDocs:
    description: "Find out more"
    url: "http://swagger.io"
    schemes:
    - "https"
    - "http"
    paths:
    /pet:
    post:
    tags:
    - "pet"
    summary: "Add a new pet to the store"
    description: ""
    operationId: "addPet"
    consumes:
    - "application/json"
    - "application/xml"
    produces:
    - "application/xml"
    - "application/json"
    parameters:
    - in: "body"
    name: "body"
    description: "Pet object that needs to be added to the store"
    required: true
    schema:
    $ref: "#/definitions/Pet"
    responses:
    405:
    description: "Invalid input"
    security:
    - petstore_auth:
    - "write:pets"
    - "read:pets"
    /pet:
    post:
    tags:
    - "pet"
    summary: "Add a new pet to the store"
    description: ""
    operationId: "addPet"
    consumes:
    - "application/json"
    - "application/xml"
    produces:
    - "application/xml"
    - "application/json"
    parameters:
    - in: "body"
    name: "body"
    description: "Pet object that needs to be added to the store"
    required: true
    schema:
    $ref: "#/definitions/User"
    responses:
    405:
    description: "Invalid input"
    security:
    - petstore_auth:
    - "write:pets"
    - "read:pets"
    securityDefinitions:
    petstore_auth:
    type: "oauth2"
    authorizationUrl: "http://petstore.swagger.io/oauth/dialog"
    flow: "implicit"
    scopes:
    write:pets: "modify pets in your account"
    read:pets: "read your pets"
    api_key:
    type: "apiKey"
    name: "api_key"
    in: "header"
    definitions:
    Order:
    type: "object"
    properties:
    id:
    type: "integer"
    format: "int64"
    petId:
    type: "integer"
    format: "int64"
    quantity:
    type: "integer"
    format: "int32"
    shipDate:
    type: "string"
    format: "date-time"
    status:
    type: "string"
    description: "Order Status"
    enum:
    - "placed"
    - "approved"
    - "delivered"
    complete:
    type: "boolean"
    default: false
    xml:
    name: "Order"
    Category:
    type: "object"
    properties:
    id:
    type: "integer"
    format: "int64"
    name:
    type: "string"
    xml:
    name: "Category"
    User:
    type: "object"
    properties:
    id:
    type: "integer"
    format: "int64"
    username:
    type: "string"
    firstName:
    type: "string"
    lastName:
    type: "string"
    email:
    type: "string"
    password:
    type: "string"
    phone:
    type: "string"
    userStatus:
    type: "integer"
    format: "int32"
    description: "User Status"
    xml:
    name: "User"
    Tag:
    type: "object"
    properties:
    id:
    type: "integer"
    format: "int64"
    name:
    type: "string"
    xml:
    name: "Tag"
    Pet:
    type: "object"
    required:
    - "name"
    - "photoUrls"
    properties:
    id:
    type: "integer"
    format: "int64"
    category:
    $ref: "#/definitions/Category"
    name:
    type: "string"
    example: "doggie"
    photoUrls:
    type: "array"
    xml:
    name: "photoUrl"
    wrapped: true
    items:
    type: "string"
    tags:
    type: "array"
    xml:
    name: "tag"
    wrapped: true
    items:
    $ref: "#/definitions/Tag"
    status:
    type: "string"
    description: "pet status in the store"
    enum:
    - "available"
    - "pending"
    - "sold"
    xml:
    name: "Pet"
    ApiResponse:
    type: "object"
    properties:
    code:
    type: "integer"
    format: "int32"
    type:
    type: "string"
    message:
    type: "string"
    externalDocs:
    description: "Find out more about Swagger"
    url: "http://swagger.io"