OasComponents
OasComponents is an object representing the OpenAPI components object.
Properties
| Property | Type | Description |
|---|---|---|
| schemas | Record<RefName, OasSchema> | undefined | An optional map of schemas. |
| responses | Record<RefName, OasResponse> | undefined | An optional map of responses. |
| parameters | Record<RefName, OasParameter> | undefined | An optional map of parameters. |
| examples | Record<RefName, OasExample> | undefined | An optional map of examples. |
| requestBodies | Record<RefName, OasRequestBody> | undefined | An optional map of request bodies. |
| headers | Record<RefName, OasHeader> | undefined | An optional map of headers. |
| extensionFields | Record<RefName, unknown> | undefined | An optional map of custom fields defined by OpenAPI extensions. Keys are strings beginning with x- and values are of any valid JSON type. |
Methods
toSchemasRefNames
Returns an array of all schema RefNames in the components object.
components.toSchemasRefNames();
Return value
An array of all schema RefNames in the components object.