Manage API Metadata

Configure API metadata for API resources published in the Participant Directory. API metadata lets organisations provide additional, API-specific information that is validated against a schema defined at the ecosystem level.

---

API metadata is configured per API resource and is tied to the resource's API Family and version.

note

You can configure API metadata only when the ecosystem administrators have defined an API Family metadata schema for the relevant API Family. Without a schema, there is no defined set of fields to collect or validate.

Prerequisites

• Authorisation Server added.

• API resources published for your server.

  If you have not published any APIs yet, see Manage APIs for Discovery and Integration.

• The API resource belongs to an API Family that has an API metadata schema.

  Ecosystem administrators configure the schema when creating or updating the API Family. See Configure metadata schema.

• Organization Administrator access.

  Only Organization Administrators can edit API resource metadata.

Configure API metadata in the directory UI

1. Select Servers.

2. Select your server.

3. Select API Resources.

4. Find the API resource you want to configure, and open the Actions menu (three dots).

5. Select Configure API Metadata.

6. Provide the metadata values required by the API Family metadata schema.

7. Save.

The UI validates the provided values against the schema configured for the API Family.

tip

If Configure API Metadata is not available, the API resource's API Family likely has no metadata schema defined. Ask the ecosystem administrators to configure the API Family metadata schema.