APIInfo Object
Contains information about an API that was defined using a Swagger 2.0 description document.
This object is used by the following operations:
- Operations that reference the APIVersionInfo object
- Operations that reference the APIInfos object
The properties included in the APIInfo object are listed below.
Property | Type | Description |
---|---|---|
APIID | string |
The unique ID for a specific API. Required except when adding an API. |
Name | string | The name of the API. |
Description | string | The description of the API. Optional. |
Summary | string | A brief, plain-text description of the API. Optional. |
Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
Updated | dateTime | The date/time stamp when the resource was last updated. Used only in response messages. |
Visibility | string | The visibility setting for this resource. For a list of valid values, see Visibility Settings. |
AvatarURL | anyURI | URL for the avatar uploaded for the resource, if any. Used only in response messages. |