APIInfo

Name Description Schema Default Example

id

optional

UUID of the api registry artifact

string

null

01234567-0123-0123-0123-012345678901

name

optional

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

optional

A string that represents the context of the user's request

string

null

CalculatorAPI

version

optional

The version of the API

string

null

1.0.0

provider

optional

If the provider value is not given, the user invoking the API will be used as the provider.

string

null

admin

status

optional

This describes in which status of the lifecycle the API is

string

null

CREATED

thumbnailUri

optional

string

null

/apis/01234567-0123-0123-0123-012345678901/thumbnail