List adapters ranked for a definition kind

Returns all installed adapter modules ranked so that adapters whose compatibility list accepts the requested kind come first, followed by incompatible adapters. The default field is the top-ranked compatible and active adapter, or null when none is available. Omit kind to receive all adapters unranked.

GET /services/install/adapters

List adapters ranked for a definition kind

cURL

curl --request GET \
  --url http://localhost:9371/services/install/adapters

200

{
  "default": "<string>",
  "adapters": [
    {
      "id": "<string>",
      "name": "<string>",
      "compatible": true,
      "active": true,
      "isBuiltin": true
    }
  ]
}

Query Parameters

kind · string

Definition kind to rank against, e.g. 'openapi@3.0'. Omit to list all adapters.

Response

200

application/json

Ranked adapter list.

default · string | null · required

Default adapter id (compatible and active). Null when no compatible adapter is available.

adapters · object[] · required

All installed adapter modules, ranked so compatible adapters come first.

Show child attributes