APIVersionInfo Object
Contains API version info for an API defined using a Swagger 2.0 description document.
This object is used by the following operations:
- PUT /api/apis/versions/{ApiVersionID}/info (in the response)
- Operations that reference the addAPIRequest object
The properties included in the APIVersionInfo object are listed below.
| Property | Type | Description |
|---|---|---|
| APIVersionID | string |
The unique ID for a specific API version. Used only in responses. |
| Environment | string | The environment applicable to the API version. |
| Name | string |
The name of the API version. Note: When this object is used as part of the addAPIRequest object when adding an API, you cannot specify the version name. The initial version name defaults to v1. However, you can specify a custom name by using the VersionName field (below). |
| VersionName | string | For requests only: a custom name for the API version. Use this field if you want to specify the name of the version rather than accepting the default value (such as v1). |
| Description | string |
The description of the API version. Optional. This copy appears in the Version Notes field in the user interface. Note: You can only specify details about an API version when adding a subsequent version. |
| APIInfo | APIInfo | Contains information about an API that was defined using a Swagger 2.0 description document. |
| Tags | string[ ] |
One or more user-defined tags assigned to the API, separated by commas. Used only in response messages. Note: You can also assign specific tags to each API version. In the user interface, only the tags assigned at the API version level are displayed. |
| Visibility | string |
The visibility setting for the API; either Public, which is visible to all users, or Limited, which is visible only to API Administrators and API Scope Group members. In request messages, defaults to Public if not specified. |