UpdateCollectionRequest
The single collection edit (owner only on the user API): human metadata and/or the record contract, applied together. Send ``json_schema`` to change the contract — the FULL new schema; the backend diffs it (new fields added, missing fields DROPPED with their data, retyping rejected) and bumps the schema version. **A new required field on a collection that already holds records must carry a JSON Schema ``default``** — existing rows are backfilled with it. ``slug`` is permanent and cannot be edited.
Properties
| Name | Type | Description |
|---|---|---|
| title | object | New title (non-empty). |
| description | object | New description ('' clears it). |
| json_schema | object | The complete new JSON Schema of a record (omit to keep it). |
| indexes | array | ADDITIONAL indexes to create (existing ones are kept unless their field is dropped). Only applied together with json_schema. |
| ticket_link_field | object | Set the field whose value is a ticket unique_id (text or integer; a field of the new json_schema when one is sent). Omit to keep the current link; send null to unlink. |
| ticket_link_es_field | object | The ES ticket field the link values are matched against. Tri-state per key (omitted = kept): send it alone to retarget the join of the EXISTING link (null = back to unique_id); setting ticket_link_fie |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-collection-request-schema.json",
"title": "UpdateCollectionRequest",
"description": "The single collection edit (owner only on the user API): human metadata and/or the\nrecord contract, applied together.\n\nSend ``json_schema`` to change the contract — the FULL new schema; the backend diffs\nit (new fields added, missing fields DROPPED with their data, retyping rejected) and\nbumps the schema version. **A new required field on a collection that already holds\nrecords must carry a JSON Schema ``default``** — existing rows are backfilled with it.\n``slug`` is permanent and cannot be edited.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/onclarity-com-agent-store-api-openapi.yml#/components/schemas/UpdateCollectionRequest",
"properties": {
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title",
"description": "New title (non-empty)."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "New description ('' clears it)."
},
"json_schema": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Json Schema",
"description": "The complete new JSON Schema of a record (omit to keep it)."
},
"indexes": {
"items": {
"$ref": "#/$defs/IndexSpec"
},
"type": "array",
"title": "Indexes",
"description": "ADDITIONAL indexes to create (existing ones are kept unless their field is dropped). Only applied together with json_schema."
},
"ticket_link_field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ticket Link Field",
"description": "Set the field whose value is a ticket unique_id (text or integer; a field of the new json_schema when one is sent). Omit to keep the current link; send null to unlink."
},
"ticket_link_es_field": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ticket Link Es Field",
"description": "The ES ticket field the link values are matched against. Tri-state per key (omitted = kept): send it alone to retarget the join of the EXISTING link (null = back to unique_id); setting ticket_link_field alone keeps the current join target."
}
},
"type": "object",
"$defs": {
"IndexSpec": {
"properties": {
"fields": {
"items": {
"type": "string"
},
"type": "array",
"title": "Fields",
"description": "Schema fields the index covers (1..5)."
},
"unique": {
"type": "boolean",
"title": "Unique",
"description": "Create as a UNIQUE index.",
"default": false
}
},
"type": "object",
"required": [
"fields"
],
"title": "IndexSpec",
"description": "One requested index over the collection's dynamic table (btree, scalar fields)."
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
curl "https://apis.io/api/v1/json-schemas/onclarity-com-update-collection-request"
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.