openapi-middleware/tests/helpers/openapi-sample-v3.yaml

OpenAPI middleware for common api frameworks (pre-release version!)

openapi: 3.0.0
info:
  title: Sample API
  description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
  version: 0.1.0
securitySchemes:
  basicAuth:
    type: 'http'
    scheme: 'basic'
paths:
  /greeting:
    get:
      summary: Returns a greeting for a guest.
      description: Sample endpoint that returns a greeting.
      operationId: greetingGuest
      security:
        - basicAuth: []
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                required:
                  - responseText
                properties:
                  responseText:
                    type: string
                  responseDetails:
                    type: object
                    required:
                      - text
                    properties:
                      text:
                        type: string
    put:
      operationId: greetingNoResponse

  /greeting/:pathName:
    get:
      summary: Returns a greeting.
      description: Sample endpoint that returns a greeting.
      operationId: greetingGet
      parameters:
        - name: qsName
          in: query
          required: false
          description: query user name.
          schema:
            type: string
            minimum: 1
        - name: pathName
          in: path
          required: false
          description: path user name.
          schema:
            type: string
            minimum: 1
      responses:
        '200':
          description: Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  responseText:
                    type: string
    post:
      summary: Returns a greeting
      operationId: greetingCreate
      parameters:
        - name: qsName
          in: query
          required: false
          description: query user name.
          schema:
            type: string
            minimum: 1
        - name: pathName
          in: path
          required: false
          description: path user name.
          schema:
            type: string
            minimum: 1
      requestBody:
        description: Optional description in *Markdown*
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - bodyName
              properties:
                bodyName:
                  type: string
      responses:
        '200':
          description: Greeting response
          content:
            application/json:
              schema:
                type: object
                required:
                  - responseText
                properties:
                  responseText:
                    type: string
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                type: object
                properties:
                  responseText:
                    type: string