petstore.yaml

openapi: "3.1.0"
info:
  version: 1.0.0
  title: Petstore
  description: |-
    Service for managing pet metadata.

    Because why not.
servers:
  - url: https://example.com/api
    description: Example Petstore implementation service
  - url: /api
  - url: '{protocol}://{subdomain}.example.com:{port}/{basePath}'
    description: A custom domain.
    variables:
      protocol:
        default: https
      subdomain:
        default: test
        description: A subdomain name.
      port:
        enum:
          - '443'
          - 8443
        default: '443'
      basePath:
        default: v1
        description: The base API path.
paths:
  /pets:
    summary: Work with pets
    description: "Even more information about working with pets"
    get:
      summary: List all pets
      description: "You can fetch\r\nall the pets here"
      operationId: listPets
      tags:
        - pets
      parameters:
        - name: limit
          in: query
          description: How many items to return at one time (max 100)
          required: false
          schema:
            type: integer
            format: int32
        - name: habitat
          in: query
          schema:
            enum:
            - water
            - land
            - air
            - ""
            type: string
        - name: feeds
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - omnivore
                - carnivore
                - herbivore
        - name: My-Request-UUID
          in: header
          description: Request identifier
          schema:
            format: uuid
            type: string
        - $ref: '#/components/parameters/query.born-since'
      responses:
        '200':
          description: A paged array of pets
          headers:
            My-Response-UUID:
              description: Response identifier
              required: true
              schema:
                type: string
            My-Tracing-Header:
              $ref: '#/components/headers/TracingHeader'
          content:
            application/json:    
              schema:
                $ref: "#/components/schemas/Pets"
        default:
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
    post:
      summary: Create a pet
      operationId: createPet
      tags:
        - pets
      parameters:
        - name: X-Extra-Arguments
          in: header
          required: false
          description: "A description here."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CodeError'
      requestBody:
        required: true
        description: "Create a pet with these properties"
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePetRequest'
      responses:
        '201':
          description: Successfully created pet
          headers:
            X-Extra-Arguments: 
              required: false
              description: "A description here."
              content:
                application/json:
                  schema:
                    $ref: '#/components/schemas/CodeError'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
        '4XX':
          $ref: '#/components/responses/ErrorBadRequest'
  /pets/create:
    summary: Work with pets
    description: "Create a pet with a URL form"
    post:
      summary: Create a pet using a url form
      operationId: createPetWithForm
      tags:
        - pets
      parameters:
      requestBody:
        required: true
        description: "Create a pet with these properties"
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePetRequest'
      responses:
        '204':
          description: Successfully created pet using a url form
  /pets/stats:
    get:
      operationId: getStats
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PetStats'
            text/plain: {}
            application/octet-stream: {}
    post:
      operationId: postStats
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PetStats'
          text/plain: {}
          application/octet-stream: {}
      responses:
        '202':
          description: Accepted data.
  /probe/:
    post:
      operationId: probe
      responses:
        '204':
          description: Ack
  /pets/{petId}:
    parameters:
      - name: petId
        in: path
        required: true
        description: Id of the pet
        schema:
          type: integer
          format: int64
    patch:
      operationId: updatePet
      description: Update just a specific property of an existing pet. Nothing is updated if no request body is provided.
      requestBody:
        $ref: '#/components/requestBodies/UpdatePetRequest'
      responses:
        '204':
          description: Successfully updated
        '400':
          description: Update input error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
  /pets/{petId}/avatar:
    parameters:
      - $ref: '#/components/parameters/path.petId'
    put:
      summary: Upload an avatar
      operationId: uploadAvatarForPet
      requestBody:
        required: true
        description: Image contents
        content:
          application/octet-stream:
            schema:
              contentEncoding: binary
              type: string
      responses:
        '200':
          description: Echoes avatar back
          content:
            application/octet-stream:
              schema:
                contentEncoding: binary
                type: string
        '412':
          description: Avatar is not acceptable
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Server error
          content:
            text/plain:
              schema:
                type: string
  /pets/multipart-typed:
    post:
      operationId: multipartUploadTyped
      requestBody:
        $ref: '#/components/requestBodies/MultipartUploadTypedRequest'
      responses:
        '202':
          description: Successfully accepted the data.
    get:
      operationId: multipartDownloadTyped
      responses:
        '200':
          $ref: '#/components/responses/MultipartDownloadTypedResponse'
components:
  headers:
    TracingHeader:
      description: A description here.
      required: false
      schema:
        type: string
  parameters:
    query.born-since:
      description: Supply this parameter to filter pets born since the provided date.
      in: query
      name: since
      schema:
        $ref: '#/components/schemas/DOB'
    path.petId:
      name: petId
      in: path
      required: true
      description: The id of the pet to retrieve
      schema:
        type: integer
        format: int64
  schemas:
    Pet:
      type: object
      title: "Pet title"
      description: "Pet metadata"
      required:
        - id
        - name
      properties:
        id:
          description: "Pet id"
          type: integer
          format: int64
        name:
          description: "Pet name"
          type: string
        tag:
          type: string
        genome:
          description: "Pet genome (base64-encoded)"
          type: string
          contentEncoding: base64
        kind:
          $ref: '#/components/schemas/PetKind'
    MixedAnyOf:
      anyOf:
        - type: string
          format: date-time
        - $ref: '#/components/schemas/PetKind'
        - $ref: "#/components/schemas/Pet"
        - type: string
    MixedOneOf:
      oneOf:
        - type: string
          format: date-time
        - $ref: '#/components/schemas/PetKind'
        - $ref: "#/components/schemas/Pet"
    MixedAllOfPrimitive:
      allOf:
        - type: string
          format: date-time
        - type: string
    PetKind:
      type: string
      description: "Kind of pet"
      enum:
        - cat
        - dog
        - ELEPHANT
        - BIG_ELEPHANT_1
        # Test Swift identifier-unsafe characters and keyword clashes here
        - $nake
        - public
    CreatePetRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        kind:
          $ref: '#/components/schemas/PetKind'
        tag:
          type: string
        genome:
          type: string
          contentEncoding: base64
    Pets:
      type: array
      items:
        $ref: "#/components/schemas/Pet"
    Error:
      type: object
      required:
        - code
        - me$sage
      properties:
        code:
          type: integer
          format: int32
        # Use a Swift identifier-unsafe character in the name
        # to test escaping and serialization.
        me$sage:
          type: string
        extraInfo:
          $ref: '#/components/schemas/ExtraInfo'
          description: Extra information about the error.
        userData:
          description: Custom user-provided key-value pairs.
          type: object
    PetFeeding:
      type: object
      properties:
        schedule:
          type: string
          enum:
            - hourly
            - daily
            - weekly
    DOB:
      type: string
      format: date-time
    ExtraInfo:
      type: string
    NoAdditionalProperties:
      type: object
      properties:
        foo:
          type: string
      additionalProperties: false
    AnyAdditionalProperties:
      type: object
      properties:
        foo:
          type: string
      additionalProperties: true
    TypedAdditionalProperties:
      type: object
      properties:
        foo:
          type: string
      additionalProperties:
        type: integer
    ObjectWithOptionalNullableArrayOfNullableItems:
      type: object
      properties:
        foo:
          type: [array, 'null']
          items:
            type: [string, 'null']
    CodeError:
      type: object
      properties:
        code:
          type: integer
      required:
        - code
    AllOfObjects:
      allOf:
        - type: object
          properties:
            message:
              type: string
          required:
            - message
        - $ref: '#/components/schemas/CodeError'
    AnyOfObjects:
      anyOf:
        - type: object
          properties:
            message:
              type: string
          required:
            - message
        - $ref: '#/components/schemas/CodeError'
    OneOfAny:
      oneOf:
        - type: string
        - type: integer
        - $ref: '#/components/schemas/CodeError'
        - type: object
          properties:
            message:
              type: string
          required:
            - message
    PetExercise:
      type: object
      properties:
        kind:
          type: string
      required:
        - kind
    Walk:
      type: object
      properties:
        kind:
          type: string
        length:
          type: integer
      required:
        - kind
        - length
    MessagedExercise:
      allOf:
        - $ref: '#/components/schemas/PetExercise'
        - type: object
          properties:
            message:
              type: string
          required:
            - message
    OneOfObjectsWithDiscriminator:
      oneOf:
        - $ref: '#/components/schemas/Walk'
        - $ref: '#/components/schemas/MessagedExercise'
      discriminator:
        propertyName: kind
    PetStats:
      type: object
      properties:
        count:
          type: integer
      required:
        - count
    RecursivePet:
      type: object
      properties:
        name:
          type: string
        parent:
          $ref: '#/components/schemas/RecursivePet'
      required:
        - name
    RecursivePetNested:
      type: object
      properties:
        name:
          type: string
        parent:
          type: object
          properties:
            nested:
              $ref: '#/components/schemas/RecursivePetNested'
          required:
            - nested
      required:
        - name
    RecursivePetOneOfFirst:
      allOf:
        - $ref: '#/components/schemas/RecursivePetOneOf'
        - type: object
          properties:
            type:
              type: string
          required:
            - type
    RecursivePetOneOfSecond:
      allOf:
        - $ref: '#/components/schemas/Pet'
        - type: object
          properties:
            type:
              type: string
          required:
            - type
    RecursivePetOneOf:
      oneOf:
        - $ref: '#/components/schemas/RecursivePetOneOfFirst'
        - $ref: '#/components/schemas/RecursivePetOneOfSecond'
      discriminator:
        propertyName: type
    RecursivePetAnyOf:
      anyOf:
        - $ref: '#/components/schemas/RecursivePetAnyOf'
        - type: string
    RecursivePetAllOf:
      allOf:
        - type: object
          properties:
            parent:
              $ref: '#/components/schemas/RecursivePetAllOf'
  responses:
    ErrorBadRequest:
      description: Bad request
      headers:
        X-Reason:
          description: A description here.
          schema:
            type: string
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: integer
            required:
              - code
    MultipartDownloadTypedResponse:
      description: A typed multipart response.
      content:
        multipart/form-data:
          schema:
            type: object
            properties:
              log:
                type: string
              metadata:
                type: object
                properties:
                  createdAt:
                    type: string
                    format: date-time
                required:
                  - createdAt
              keyword:
                type: array
                items:
                  type: string
            required:
              - log
          encoding:
            log:
              headers:
                x-log-type:
                  description: The type of the log.
                  schema:
                    type: string
                    enum:
                      - structured
                      - unstructured
  requestBodies:
    UpdatePetRequest:
      required: false
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                description: "Pet name"
                type: string
              kind:
                $ref: '#/components/schemas/PetKind'
              tag:
                type: string
    MultipartUploadTypedRequest:
      required: true
      content:
        multipart/form-data:
          schema:
            type: object
            properties:
              log:
                type: string
              metadata:
                type: object
                properties:
                  createdAt:
                    type: string
                    format: date-time
                required:
                  - createdAt
              keyword:
                type: array
                items:
                  type: string
            required:
              - log
          encoding:
            log:
              headers:
                x-log-type:
                  description: The type of the log.
                  schema:
                    type: string
                    enum:
                      - structured
                      - unstructured