openapi
**This is an old revision of the document!**
Table of Contents
OpenAPI document structures
Sources
Structure by Version
surprising how much the structure can change between versions; here's a handful of versions to show that. note the structure is the same for JSON and YAML versions.
3.0.1
- schemas : Map[string, Schema Object | Reference Object]
- responses : Map[string, Response Object | Reference Object]
- parameters : Map[string, Parameter Object | Reference Object]
- examples : Map[string, Example Object | Reference Object]
- requestBodies : Map[string, Request Body Object | Reference Object]
- headers : Map[string, Header Object | Reference Object]
- securitySchemes : Map[string, Security Scheme Object | Reference Object]
- links : Map[string, Link Object | Reference Object]
- callbacks : Map[string, Callback Object | Reference Object]
3.0.3
- openapi : string
- info : Info Object
- servers : [Server Object]
- paths : Paths Object
- components : Components Object
- security : [Security Requirement Object]
- tags : [Tag Object]
- externalDocs: External Documentation Object
3.0.4
- same as 3.0.3! (at least the top-level structure is)
3.1.0
- openapi : string
- info : Info Object
- jsonSchemaDialect : string
- servers : [Server Object]
- paths : Paths Object
- webhooks : Map[string, Path Item Object | Reference Object] ]
- components : Components Object
- security : [Security Requirement Object]
- tags : [Tag Object]
- externalDocs : External Documentation Object
3.1.1
- same as 3.1.0 (at least the top-level structure is the same)
openapi.1738351371.txt.gz ยท Last modified: 2025/01/31 19:22 by ron