Name | Description | Schema | Default | Example |
---|---|---|---|---|
id optional |
UUID of the api registry artifact |
string | null |
01234567-0123-0123-0123-012345678901 |
name required |
Name of the API |
string | null |
CalculatorAPI |
description optional |
A brief description about the API |
string | null |
A calculator API that supports basic operations |
context required |
A string that represents thecontext of the user's request |
string | null |
CalculatorAPI |
version required |
The version of the API |
string | null |
1.0.0 |
provider required |
If the provider value is not given user invoking the api will be used as the provider. |
string | null |
admin |
apiDefinition required |
Swagger definition of the API which contains details about URI templates and scopes |
string | null |
{"paths":{"\/substract":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}},"\/add":{"get":{"x-auth-type":"Application & Application User","x-throttling-tier":"Unlimited","parameters":[{"name":"x","required":true,"type":"string","in":"query"},{"name":"y","required":true,"type":"string","in":"query"}],"responses":{"200":{}}}}},"swagger":"2.0","info":{"title":"CalculatorAPI","version":"1.0.0"}} |
wsdlUri optional |
WSDL URL if the API is based on a WSDL endpoint |
string | null |
http://www.webservicex.com/globalweather.asmx?wsdl |
status required |
This describes in which status of the lifecycle the API is. |
string | null |
PUBLISHED |
isDefaultVersion optional |
boolean | null |
false |
|
transport optional |
array | null |
["http","https"] |
|
authorizationHeader optional |
Name of the Authorization header used for invoking the API. If it is not set, Authorization header name specified in tenant or system level will be used. |
string | null |
|
tags optional |
Search keywords related to the API |
array | null |
["substract","add"] |
tiers optional |
The subscription tiers selected for the particular API |
array | null |
["Unlimited"] |
thumbnailUrl optional |
string | null |
||
additionalProperties optional |
Custom(user defined) properties of API |
map | null |
{} |
endpointURLs optional |
array | null |
||
businessInformation optional |
API_businessInformation | null |
||
labels optional |
Labels of micro-gateway environments attached to the API. |
array | null |
|
environmentList optional |
The environment list configured with non empty endpoint URLs for the particular API. |
array | null |
["PRODUCTION","SANDBOX"] |