Information about the API schema.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type_ | CreateApiSchemaType1 | ✅ | The schema's type. |
| files | List[CreateApiSchemaFiles1] | ✅ | The list of files that are part of the schema. |
The schema's type.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| PROTO2 | str | ✅ | "proto:2" |
| PROTO3 | str | ✅ | "proto:3" |
| GRAPHQL | str | ✅ | "graphql" |
| OPENAPI3_1 | str | ✅ | "openapi:3_1" |
| OPENAPI3 | str | ✅ | "openapi:3" |
| OPENAPI2 | str | ✅ | "openapi:2" |
| OPENAPI1 | str | ✅ | "openapi:1" |
| RAML1 | str | ✅ | "raml:1" |
| RAML0_8 | str | ✅ | "raml:0_8" |
| WSDL2 | str | ✅ | "wsdl:2" |
| WSDL1 | str | ✅ | "wsdl:1" |
| ASYNCAPI2 | str | ✅ | "asyncapi:2" |
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| path | str | ❌ | The schema's file path. |
| root | FilesRoot | ❌ | Information about the schema's root file. |
| content | str | ❌ | The schema file's stringified contents. |
Information about the schema's root file.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| enabled | Enabled | ❌ | If true, tag the file as the root file. The root tag is only allowed for protobuf specifications. |
If true, tag the file as the root file. The root tag is only allowed for protobuf specifications.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| TRUE | str | ✅ | "true" |