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.
https://api.example.com/platformRegistries
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.
| 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 |
▶
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.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| type | string | path | ✓ | A registry type the contracts declare, e.g. |
| ▶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 |
▶
GET
/registry/{type}/{entryId}
Get a registry entry
#
One entry of a registry type, by its id.
| Name | Type | In | Req | Description |
|---|---|---|---|---|
| type | string | path | ✓ | A registry type the contracts declare, e.g. |
| entryId | string | path | ✓ | The entry's stable id, e.g. |