Named, citable entries the contracts declare in registry files — regulatory policies, sources, design patterns — readable by type. Entries carry a description and whatever fields their type defines.

Base URL: https://api.example.com/platform

Registries

Entries the contracts declare in registry files, by type.

▶ GET /registry List registry types

Every registry type the contracts declare, with how many entries each has, in name order. q matches a type's name.

Parameters
Name Type In Req Description
▶q string query Search query using field:value syntax. Multiple conditions separated by
limit integer query

Maximum number of items to return (1-100).

offset integer query

Number of items to skip before collecting results.

▶sort string query Comma-separated list of fields to sort the response by. Prefix a field
Responses
200 The registry types, in name order.
▶ RegistryTypeList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[RegistryType] required
type string required The registry type, as its files declare it.
total integer required How many entries it has, across every file of the type.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /registry/{type} List a registry's entries

Every entry of one registry type, from every file of that type, in id order. q matches an entry's id or description.

Parameters
Name Type In Req Description
type string path ✓

A registry type the contracts declare, e.g. policies.

▶q string query Search query using field:value syntax. Multiple conditions separated by
limit integer query

Maximum number of items to return (1-100).

offset integer query

Number of items to skip before collecting results.

▶sort string query Comma-separated list of fields to sort the response by. Prefix a field
Responses
200 Paginated list of entries.
▶ RegistryEntryList
total integer required Total number of items available.
limit integer required Maximum number of items requested.
offset integer required Number of items skipped before the current page.
hasNext boolean Whether more items are available beyond the current page.
▶ items array[RegistryEntry] required
id string required The entry's stable id.
description string required Human-readable text for the entry.
deprecated boolean When true, the entry should not be newly referenced.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
▶ GET /registry/{type}/{entryId} Get a registry entry

One entry of a registry type, by its id.

Parameters
Name Type In Req Description
type string path ✓

A registry type the contracts declare, e.g. policies.

entryId string path ✓

The entry's stable id, e.g. snap-processing-clock.

Responses
200 The entry.
▶ RegistryEntry
id string required The entry's stable id.
description string required Human-readable text for the entry.
deprecated boolean When true, the entry should not be newly referenced.
404 The requested resource was not found.
▶ NotFound
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.
500 An unexpected error occurred on the server.
▶ InternalError
code string required Machine-readable error code.
message string required Human-readable error description.
details array[object] Additional error details.