API

Name Description Schema Default Example

id

optional

UUID of the api registry artifact

string

null

01234567-0123-0123-0123-012345678901

name

required

string

null

CalculatorAPI

description

optional

string

null

A calculator API that supports basic operations

context

required

string

null

CalculatorAPI

version

required

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

string

null

PUBLISHED

isDefaultVersion

optional

boolean

null

false

transport

optional

array

null

null

tags

optional

array

null

null

tiers

optional

array

null

null

thumbnailUrl

optional

string

null

endpointURLs

optional

array

null

null

businessInformation

optional

API_businessInformation

null

null