openapi-examples-validator/test/data/v3/additional-properties/schema-with-examples.yaml

Validates embedded examples in OpenAPI-JSONs

openapi: 3.0.0
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: 'http://petstore.swagger.io/v1'
paths:
  /pets:
    get:
      summary: List all pets
      operationId: listPets
      responses:
        '200':
          description: An array of pets
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pets'
              examples:
                single:
                  value:
                    - id: 0
                      name: Herbert
                      tag: Doggo
                      owner: John
                      age: 5
                      schema:
                        properties:
                          color: black
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      summary: Create a pet
      operationId: createPets
      tags:
        - pets
      responses:
        '201':
          description: Null response
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  '/pets/{petId}':
    get:
      summary: Info for a specific pet
      operationId: showPetById
      parameters:
        - name: petId
          in: path
          required: true
          description: The id of the pet to retrieve
          schema:
            type: string
      responses:
        '200':
          description: Expected response to a valid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'
              example:
                id: 0
                name: Herbert
                tag: Doggo
                owner: John
                age: 5
                schema:
                  properties:
                    color: black
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Pet:
      required:
        - id
        - name
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        tag:
          type: string
        # This intentionally is a property called `schema`
        schema:
          type: object
          properties:
            # This intentionally is a property called `properties`
            properties:
              type: object
              # This should not be extended with an `additionalProperties: false`
              properties:
                color:
                  type: string

    Pets:
      type: array
      items:
        $ref: '#/components/schemas/Pet'
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: number
        message:
          type: string