Information about the API version.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| Name | string | ✅ | The version's name. |
| Branch | string | ✅ | The branch ID. |
| Schemas | List<CreateApiVersion3Schemas> |
✅ | A list of the version's schemas. |
| Collections | List<CreateApiVersion3Collections> |
✅ | A list of the version's collections. |
| ReleaseNotes | string | ❌ | Information about the API version release. For example, changelog notes. |
Information about the schema.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DirectoryPath | string | ❌ | The path to the root directory where schemas are stored in the Git repository. |
Information about the collection.
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| FilePath | string | ❌ | The path to the collection in the Git repository. |