v1

latestOpenAPI 3.0.02026-07-17112.5 KB
OpenAPI

Get a valid OpenAPI 3.0 document with all REST APIs available from a Liberty instance

Returns a valid OpenAPI 3.0 document with all REST APIs available from a Liberty instance merged into a single document. This is useful for consumer applications that want to programmatically navigate the set of available APIs, such as an API Management solution. By default, the document is returned in YAML format. Including an optional 'Accept' header with an 'application/json' value provides the document in JSON format. This endpoint has two multiple-cardinality, optional query parameters called 'root' that can filter the found context roots and 'compact' that can control whether the output should be formatted or not.

get/ibm/api/docs

Query parameters

rootstring[]

Filter the found context roots

compactboolean

Indicates if the output will contain any indenting white spaces, new line feeds, etc. By default, the output will not be compacted

Headers

accept'application/json' | 'application/yaml'

Format of the returned document

Response

All available or filtered REST APIs from a Liberty instance merged into a single document

string required
All 1 operations