The root object of an OpenAPI 3.1 document.
Value parameters
- components
-
An element to hold various schemas for the document.
- extensions
-
Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.
- externalDocs
-
Additional external documentation.
- info
-
REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
- jsonSchemaDialect
-
The default value for the $$schema keyword within Schema Objects contained within this OAS document. This MUST be in the form of a URI.
- openapi
-
REQUIRED. This string MUST be the version number of the OpenAPI Specification that the OpenAPI document uses. The openapi field SHOULD be used by tooling to interpret the OpenAPI document.
- paths
-
The available paths and operations for the API.
- security
-
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used.
- servers
-
An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
- tags
-
A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools.
Attributes
- Companion
- object
- Source
- OpenAPI.scala
- Graph
-
- Supertypes