OpenAPI Specification Schemas: Difference between revisions
Jump to navigation
Jump to search
(→Schema) |
|||
| Line 12: | Line 12: | ||
<font size=-2> | <font size=-2> | ||
<font color=brick>SchemaName</font> | <font color=brick>SchemaName</font> | ||
type: | [[#type|type]]: | ||
required: | required: | ||
properties: | properties: | ||
format: | [[#format|format]]: | ||
description: | description: | ||
discriminator: | discriminator: | ||
| Line 24: | Line 24: | ||
==<tt>type</tt>== | ==<tt>type</tt>== | ||
==<tt>format</tt>== | |||
=Example= | =Example= | ||
Revision as of 02:07, 26 January 2024
External
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject
- https://tools.ietf.org/html/draft-bhutton-json-schema-00
- https://tools.ietf.org/html/draft-bhutton-json-schema-validation-00
Internal
Overview
The /components/schemas section of the OpenAPI specification defines reusable types that are used as input and output data types. These types can represent objects, but also primitives and arrays. The specification is based on JSON Schema Specification Draft 2020-12. A client or server code generator creates programming language types from these schemas. This article is annotated with details related to how oapi-codegen generates Go code.
Schema
SchemaName type: required: properties: format: description: discriminator: externalDocs:
Schema Name
type
format
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
Composition
allOf
Polymorphism
discriminator