OasDocument
OasDocument is an object representing an OpenAPI document.
Properties
| Property | Type | Description |
|---|---|---|
| oasType | 'openapi' | Static value representing the OpenAPI document type. |
| openapi | string | The version of the OpenAPI specification used by the document. |
| info | OasInfo | OasInfo object representing the API information. |
| operations | OasOperation[] | Array of OasOperation objects representing the API operations. |
| components | OasComponents | undefined | OasComponents object containing re-usable schema items within the API |
| tags | OasTag[] | undefined | Optional array of OasTag objects. |
| extensionFields | Record<string, unknown> | undefined | Optional map of custom fields defined by OpenAPI extensions. Keys are strings beginning with x- and values are of any valid JSON type. |