Resource: Api
An API resource in the API Hub.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "documentation": { object ( |
Fields | |
---|---|
name |
Identifier. The name of the API resource in the API Hub. Format: |
display |
Required. The display name of the API resource. |
description |
Optional. The description of the API resource. |
documentation |
Optional. The documentation for the API resource. |
owner |
Optional. Owner details for the API resource. |
versions[] |
Output only. The list of versions present in an API resource. Note: An API resource can be associated with more than 1 version. Format is |
create |
Output only. The time at which the API resource was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
update |
Output only. The time at which the API resource was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
target |
Optional. The target users for the API. This maps to the following system defined attribute: |
team |
Optional. The team owning the API. This maps to the following system defined attribute: |
business |
Optional. The business unit owning the API. This maps to the following system defined attribute: |
maturity |
Optional. The maturity level of the API. This maps to the following system defined attribute: |
attributes |
Optional. The list of user defined attributes associated with the API resource. The key is the attribute name. It will be of the format: An object containing a list of |
api |
Optional. The style of the API. This maps to the following system defined attribute: |
selected |
Optional. The selected version for an API resource. This can be used when special handling is needed on client side for particular version of the API. Format is |
Methods |
|
---|---|
|
Create an API resource in the API hub. |
|
Delete an API resource in the API hub. |
|
Get API resource details including the API versions contained in it. |
|
List API resources in the API hub. |
|
Update an API resource in the API hub. |