One published application, with its OpenAPI document

GET

/v1/catalog/{app}

const url = 'https://api.eu.apigami.com/v1/catalog/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.eu.apigami.com/v1/catalog/example

The card of one application, named by its slug, unique on all of Apigami: its identifier, the OpenAPI document of the version it has in production — so every action with its input schema — and the sites a call to it may touch, each one saying whether the request leaves the user’s own browser with their session or the application makes it itself, and which application it comes from. Only the version in production is described. Code should key off app_id: a slug can be renamed.

Parameters

Path Parameters

app

required

string

>= 3 characters <= 32 characters

Responses

200

The application, its effective sites and its OpenAPI document.

application/json

object

app_id

required

What code written against this application uses. A public name can be changed; this cannot.

string format: uuid

slug

required

Unique on all of Apigami; it names the application’s host, {slug}.apigami.tech.

string

group

The slug of its team, when the team has one.

string | null

name

required

The application’s own name, fixed outside any version; it does not change when a version is published.

string

title

The info.title of the version in production, so it changes at every publication.

string

description

string | null

version_id

string format: uuid

version

The version its author declared, info.version of the manifest. version_id identifies the row; this is what the author wrote.

string | null

visibility

string

Allowed values: unlisted public

reviewed

boolean

callable_by_other_groups

False until Apigami has reviewed the version in production.

boolean

published_at

string | null format: date-time

actions

required

Array<object>

object

action

required

Its operationId, which is the name you call.

string

summary

string | null

description

string | null

method

required

string

path

required

string

domains

required

Array<object>

object

domain

required

string

via

required

extension: the request leaves the user’s browser with their session, and they approve the site. direct: the application calls it itself, with its own credentials.

string

Allowed values: extension direct

via_app_id

required

Null when this application declares the site itself; otherwise the application it comes from.

string | null format: uuid

openapi

required

The OpenAPI 3.1 document of the version in production, x-apigami block included.

object | null

Example

{
  "visibility": "unlisted",
  "domains": [
    {
      "via": "extension"
    }
  ]
}

404

No such published application.

application/json

object

error

required

string

consentPending

Present and true when the approval window is open and the user has not answered within 45 s.

boolean

Example

{
  "error": "not found"
}