OpenAPI Specification Schemas

External

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject

Internal

• OpenAPI Specification

Overview

The /components/schemas section of the OpenAPI specification defines reusable objects a client or server code generator creates programming language types for. This article is annotated with details related to how <codeoapi-codegen generates Go code.

Example

components:
  schemas:
    Pet:
      allOf:
        - $ref: '#/components/schemas/NewPet'
        - type: object
          required:
            - id
          properties:
            id:
              type: integer
              format: int64
    NewPet:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        tag:
          type: string
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string