Skip to content
Embabel Worlds

List every realm API operation available to a user, classified read-only vs write

GET
/api/v1/admin/code-action/catalog
curl --request GET \
  --url 'http://localhost:11044/api/v1/admin/code-action/catalog?username=example' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
username
required
string

Login username of the user whose installed realms’ API operations are listed; an unknown username is refused with 400

Responses

Section titled “Responses”

200

Section titled “200”

The catalog

Media typeapplication/json

Every realm API operation available to a user, counted per source, with a sample

object
bySource
required

The operations counted per source realm, keyed by source name in sorted order

object
key
additional properties

One source’s operations, split by whether they only read

object
readOnly
required

The operations classified read-only

integer format: int32
total
required

Every operation from this source

integer format: int32
write
required

The operations classified as writes: total less readOnly

integer format: int32
sample
required

Up to twenty operations, sorted by gateway name

Array<object>

One realm API operation, as the catalog samples it

object
op
required

The operation’s gateway name

string
readOnly
required

True when the operation only reads

boolean
source
required

The realm the operation comes from

string
totalRealmOps
required

How many realm API operations the user can reach

integer format: int32
username
required

The user the catalog was built for, as given

string

Example generated

{
  "bySource": {
    "additionalProperty": {
      "readOnly": 1,
      "total": 1,
      "write": 1
    }
  },
  "sample": [
    {
      "op": "example",
      "readOnly": true,
      "source": "example"
    }
  ],
  "totalRealmOps": 1,
  "username": "example"
}

400

Section titled “400”

Unknown username

Media typeapplication/json

A refusal carrying only its reason, with no status word

object
error
required

Why the request was refused, written to be shown

string

Example generated

{
  "error": "example"
}