{ "components": { "schemas": { "AssigneeListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "email" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "AssignmentCommand": { "additionalProperties": false, "properties": { "assignee_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "A person from `listEntryAssignees`, or null to clear." }, "due_date": { "anyOf": [ { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, { "type": "null" } ], "description": "YYYY-MM-DD, today or later. Absent or null: no due date." }, "expected_workflow_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "expected_workflow_revision", "assignee_id" ], "type": "object" }, "AssignmentResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "assignee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "due_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_instance_id": { "minLength": 1, "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "state": { "type": "string" } }, "required": [ "primary_instance_id", "state", "assignee_id", "due_date", "revision" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ChromeDefaultsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "declared_regions": { "description": "The regions this site’s template declares. The template decides where each appears.", "items": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label" ], "type": "object" }, "type": "array" }, "footer": { "additionalProperties": false, "properties": { "note": { "additionalProperties": { "type": "string" }, "description": "Language to the footer note, at most 600 characters. Empty: no note.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "note" ], "type": "object" }, "regions": { "additionalProperties": { "additionalProperties": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The shared section’s id.", "minLength": 1, "type": "string" }, "kind": { "const": "shared_section", "type": "string" } }, "required": [ "kind", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "menu", "type": "string" }, "menu": { "description": "A menu key of this Site Chrome.", "minLength": 1, "type": "string" } }, "required": [ "kind", "menu" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "search", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "count": { "maximum": 10, "minimum": 1, "type": "integer" }, "kind": { "const": "recent_posts", "type": "string" } }, "required": [ "kind", "count" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "categories", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "tags", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "monthly_archive", "type": "string" } }, "required": [ "kind" ], "type": "object" } ] }, "type": "array" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "description": "Language code to region key to that region’s ordered items, at most 8. A language without a list of its own for a region follows the site’s strict or fallback rule; an empty list shows nothing. Only regions in `declared_regions` may change. recent_posts, categories, tags, monthly_archive are Blog-only.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these settings come from; null when none is accepted. A save names it." }, "routes": { "description": "Named site paths a generated link may target, at most 24, keys and paths unique.", "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "path": { "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "footer", "routes", "regions", "declared_regions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ChromeDefaultsUpdate": { "additionalProperties": false, "properties": { "expected_revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these settings come from; null when none is accepted. A save names it." }, "footer": { "additionalProperties": false, "properties": { "note": { "additionalProperties": { "type": "string" }, "description": "Language to the footer note, at most 600 characters. Empty: no note.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "note" ], "type": "object" }, "regions": { "additionalProperties": { "additionalProperties": { "items": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "type": "array" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "description": "Language code to region key to that region’s ordered items, at most 8. A language without a list of its own for a region follows the site’s strict or fallback rule; an empty list shows nothing. Only regions in `declared_regions` may change. recent_posts, categories, tags, monthly_archive are Blog-only. Items: shared_section, menu, search, recent_posts, categories, tags, monthly_archive. Replaced whole.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "routes": { "description": "Replaced whole.", "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "path": { "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": "array" } }, "required": [ "expected_revision" ], "type": "object" }, "ChromeDefaultsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "declared_regions": { "description": "The regions this site’s template declares. The template decides where each appears.", "items": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label" ], "type": "object" }, "type": "array" }, "draft": { "description": "Unaccepted Site Chrome changes: none, kept with this change written in, or left for a person to re-apply.", "enum": [ "none", "carried", "needs_rebase" ], "type": "string" }, "footer": { "additionalProperties": false, "properties": { "note": { "additionalProperties": { "type": "string" }, "description": "Language to the footer note, at most 600 characters. Empty: no note.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "note" ], "type": "object" }, "regions": { "additionalProperties": { "additionalProperties": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The shared section’s id.", "minLength": 1, "type": "string" }, "kind": { "const": "shared_section", "type": "string" } }, "required": [ "kind", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "menu", "type": "string" }, "menu": { "description": "A menu key of this Site Chrome.", "minLength": 1, "type": "string" } }, "required": [ "kind", "menu" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "search", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "count": { "maximum": 10, "minimum": 1, "type": "integer" }, "kind": { "const": "recent_posts", "type": "string" } }, "required": [ "kind", "count" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "categories", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "tags", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "monthly_archive", "type": "string" } }, "required": [ "kind" ], "type": "object" } ] }, "type": "array" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "description": "Language code to region key to that region’s ordered items, at most 8. A language without a list of its own for a region follows the site’s strict or fallback rule; an empty list shows nothing. Only regions in `declared_regions` may change. recent_posts, categories, tags, monthly_archive are Blog-only.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "revision": { "minLength": 1, "type": "string" }, "routes": { "description": "Named site paths a generated link may target, at most 24, keys and paths unique.", "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "path": { "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": "array" } }, "required": [ "revision", "footer", "routes", "regions", "declared_regions", "draft" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "CommentDelete": { "additionalProperties": false, "properties": { "comments": { "items": { "additionalProperties": false, "properties": { "expected": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "expected" ], "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "comments" ], "type": "object" }, "CommentDeleteResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "cache": { "additionalProperties": {}, "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "results": { "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "outcome": { "enum": [ "deleted", "conflict", "not_found" ], "type": "string" }, "replies": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "anyOf": [ { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "outcome", "state", "replies" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "CommentListResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "body": { "type": "string" }, "consent": { "type": "boolean" }, "created_at": { "type": "string" }, "entry": { "additionalProperties": false, "properties": { "group_id": { "minLength": 1, "type": "string" }, "instance_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "lang": { "type": "string" }, "model": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "slug", "name" ], "type": "object" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "model", "group_id", "instance_id", "lang", "title", "slug" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "import_published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "moderated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "reacted": { "items": { "enum": [ "helpful" ], "type": "string" }, "type": "array" }, "reactions": { "additionalProperties": false, "properties": { "helpful": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "helpful" ], "type": "object" }, "replies": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "entry", "parent_id", "state", "name", "website", "body", "created_at", "moderated_at", "replies", "consent", "import_published_at", "reactions", "reacted" ], "type": "object" }, "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "CommentModerate": { "additionalProperties": false, "properties": { "comments": { "description": "Each comment once, with the state it was read in.", "items": { "additionalProperties": false, "properties": { "expected": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "expected" ], "type": "object" }, "maxItems": 25, "minItems": 1, "type": "array" }, "to": { "enum": [ "approved", "refused", "spam" ], "type": "string" } }, "required": [ "to", "comments" ], "type": "object" }, "CommentModerateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "cache": { "additionalProperties": {}, "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "results": { "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "outcome": { "enum": [ "moderated", "conflict", "not_found", "consent_missing", "has_consent" ], "type": "string" }, "state": { "anyOf": [ { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "outcome", "state" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "CommentPublishImported": { "additionalProperties": false, "properties": { "expected": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "expected" ], "type": "object" }, "CommentPublishImportedResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "cache": { "additionalProperties": {}, "properties": { "status": { "type": "string" } }, "required": [ "status" ], "type": "object" }, "results": { "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "outcome": { "enum": [ "moderated", "conflict", "not_found", "consent_missing", "has_consent" ], "type": "string" }, "state": { "anyOf": [ { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "outcome", "state" ], "type": "object" }, "type": "array" } }, "required": [ "results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "CommentResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "body": { "type": "string" }, "consent": { "type": "boolean" }, "created_at": { "type": "string" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "entry": { "additionalProperties": false, "properties": { "group_id": { "minLength": 1, "type": "string" }, "instance_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "lang": { "type": "string" }, "model": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "slug", "name" ], "type": "object" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "model", "group_id", "instance_id", "lang", "title", "slug" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "import_published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "moderated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "parent": { "anyOf": [ { "additionalProperties": false, "properties": { "body": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "state": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" } }, "required": [ "id", "name", "body", "state" ], "type": "object" }, { "type": "null" } ] }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "reacted": { "items": { "enum": [ "helpful" ], "type": "string" }, "type": "array" }, "reactions": { "additionalProperties": false, "properties": { "helpful": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "helpful" ], "type": "object" }, "replies": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "enum": [ "pending", "approved", "spam", "refused" ], "type": "string" }, "website": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "entry", "parent_id", "state", "name", "website", "body", "created_at", "moderated_at", "replies", "consent", "import_published_at", "reactions", "reacted", "email", "parent" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "CommentSettingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "models": { "description": "Every model of the site and whether its public entries take comments.", "items": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "slug", "name", "enabled" ], "type": "object" }, "type": "array" } }, "required": [ "models" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "CommentSettingsUpdate": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "model": { "description": "The model slug.", "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "model", "enabled" ], "type": "object" }, "CommentSettingsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "models": { "description": "Every model of the site and whether its public entries take comments.", "items": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "slug", "name", "enabled" ], "type": "object" }, "type": "array" } }, "required": [ "models" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "DependentsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "dependents": { "items": { "additionalProperties": {}, "properties": { "instance_id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "model_slug": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "instance_id", "slug", "lang", "model_slug" ], "type": "object" }, "type": "array" }, "ids": { "items": { "minLength": 1, "type": "string" }, "type": "array" } }, "required": [ "dependents", "ids" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "EditingStateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "draft": { "anyOf": [ { "additionalProperties": false, "properties": { "baseline_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": {}, "expires_at": { "type": "string" }, "kind": { "enum": [ "content", "page" ], "type": "string" }, "locale": { "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "target": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "kind", "target", "locale", "baseline_version_id", "revision", "data", "updated_at", "expires_at" ], "type": "object" }, { "type": "null" } ] }, "expired": { "type": "boolean" }, "holder": { "anyOf": [ { "additionalProperties": false, "properties": { "name": { "type": "string" }, "self": { "type": "boolean" }, "this_session": { "type": "boolean" } }, "required": [ "name", "self", "this_session" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "holder", "draft", "expired" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "EditingTakeOver": { "additionalProperties": false, "properties": { "locale": { "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$", "type": "string" } }, "required": [ "locale" ], "type": "object" }, "EditingTakeOverResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "draft": { "anyOf": [ { "additionalProperties": false, "properties": { "baseline_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": {}, "expires_at": { "type": "string" }, "kind": { "enum": [ "content", "page" ], "type": "string" }, "locale": { "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "target": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "kind", "target", "locale", "baseline_version_id", "revision", "data", "updated_at", "expires_at" ], "type": "object" }, { "type": "null" } ] }, "expired": { "type": "boolean" }, "holder": { "anyOf": [ { "additionalProperties": false, "properties": { "name": { "type": "string" }, "self": { "type": "boolean" }, "this_session": { "type": "boolean" } }, "required": [ "name", "self", "this_session" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "holder", "draft", "expired" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "EditorialSettingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "review_flow": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether entries pass through review before publishing. Null: unreadable." }, "revisions": { "additionalProperties": false, "properties": { "review_flow": { "pattern": "^[0-9a-f]{16}$", "type": "string" }, "versions_to_keep": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "versions_to_keep", "review_flow" ], "type": "object" }, "versions_to_keep": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ], "description": "Versions each entry keeps. Null: the stored value is unreadable and saves refuse until it is set again." } }, "required": [ "versions_to_keep", "review_flow", "revisions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "EditorialSettingsUpdate": { "additionalProperties": false, "properties": { "expected_revisions": { "additionalProperties": false, "properties": { "review_flow": { "description": "The revision of `review_flow` this change was made against. A stale one is refused with `settings_changed_concurrently`.", "pattern": "^[0-9a-f]{16}$", "type": "string" }, "versions_to_keep": { "description": "The revision of `versions_to_keep` this change was made against. A stale one is refused with `settings_changed_concurrently`.", "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "type": "object" }, "review_flow": { "description": "Turning review off is refused while entries wait in a review step; they are named.", "type": "boolean" }, "versions_to_keep": { "description": "A whole number, at least 1. Older versions beyond it are deleted on the next save.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "expected_revisions" ], "type": "object" }, "EditorialSettingsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "review_flow": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Whether entries pass through review before publishing. Null: unreadable." }, "revisions": { "additionalProperties": false, "properties": { "review_flow": { "pattern": "^[0-9a-f]{16}$", "type": "string" }, "versions_to_keep": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "versions_to_keep", "review_flow" ], "type": "object" }, "versions_to_keep": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ], "description": "Versions each entry keeps. Null: the stored value is unreadable and saves refuse until it is set again." } }, "required": [ "versions_to_keep", "review_flow", "revisions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "EntryCreate": { "additionalProperties": false, "properties": { "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale_relations": { "additionalProperties": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, { "additionalProperties": false, "properties": { "set": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" } }, "required": [ "set" ], "type": "object" }, { "additionalProperties": false, "properties": { "connect": { "description": "Items to add, in array order. A plain id goes to the end. `{ id, position }` places it. Positions on a single-target relation are refused (`relation_position_not_ordered`).", "items": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "disconnect": { "description": "Items to remove first.", "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, "move": { "description": "Items already related to reposition, in array order, after disconnect and connect. An item not related is refused (`relation_move_target_missing`).", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id", "position" ], "type": "object" }, "type": "array" } }, "type": "object" } ], "description": "A plain list or `{ set }` replaces the list. `{ connect, disconnect, move }` edits it: disconnect, then connect, then move; the result is the same for the same input." }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "description": "Each language's own lists, for a relation field with different links in each language.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "additionalProperties": {}, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "media": { "additionalProperties": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "crop": { "anyOf": [ { "additionalProperties": false, "properties": { "height": { "maximum": 1, "minimum": 0, "type": "number" }, "width": { "maximum": 1, "minimum": 0, "type": "number" }, "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y", "width", "height" ], "type": "object" }, { "type": "null" } ] }, "focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "model_id": { "minLength": 1, "type": "string" }, "primary_lang": { "minLength": 1, "type": "string" }, "relations": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, { "additionalProperties": false, "properties": { "set": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" } }, "required": [ "set" ], "type": "object" }, { "additionalProperties": false, "properties": { "connect": { "description": "Items to add, in array order. A plain id goes to the end. `{ id, position }` places it. Positions on a single-target relation are refused (`relation_position_not_ordered`).", "items": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "disconnect": { "description": "Items to remove first.", "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, "move": { "description": "Items already related to reposition, in array order, after disconnect and connect. An item not related is refused (`relation_move_target_missing`).", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id", "position" ], "type": "object" }, "type": "array" } }, "type": "object" } ], "description": "A plain list or `{ set }` replaces the list. `{ connect, disconnect, move }` edits it: disconnect, then connect, then move; the result is the same for the same input." }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "seo": { "additionalProperties": { "anyOf": [ { "additionalProperties": false, "properties": { "canonical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "const": 1, "type": "number" }, "image": { "anyOf": [ { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_id": { "minLength": 1, "type": "string" } }, "required": [ "media_id" ], "type": "object" }, { "type": "null" } ] }, "robots": { "enum": [ "index", "noindex" ], "type": "string" }, "schema_type": { "anyOf": [ { "enum": [ "WebPage", "AboutPage", "ContactPage", "Article" ], "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "format" ], "type": "object" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "slugs": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Each language's own address. `null` on create: no address in that language.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" } }, "required": [ "model_id", "locales" ], "type": "object" }, "EntryListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lang": { "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "model_slug": { "type": "string" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translation_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "instance_id", "primary_instance_id", "translation_group_id", "model_id", "model_slug", "lang", "label", "slug", "current_version_id", "published_version_id" ], "type": "object" }, "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "next" ], "type": "object" }, "EntryResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lang": { "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "model_slug": { "type": "string" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translation_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "workflow": { "anyOf": [ { "additionalProperties": false, "properties": { "locales": { "items": { "additionalProperties": false, "properties": { "instance_id": { "type": "string" }, "locale": { "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "type": "string" }, "transitions": { "items": { "additionalProperties": false, "properties": { "kind": { "enum": [ "publish", "unpublish", "move" ], "type": "string" }, "to": { "type": "string" } }, "required": [ "to", "kind" ], "type": "object" }, "type": "array" } }, "required": [ "locale", "instance_id", "state", "published_version_id", "transitions" ], "type": "object" }, "type": "array" }, "revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "state": { "type": "string" }, "transitions": { "items": { "additionalProperties": false, "properties": { "kind": { "enum": [ "publish", "unpublish", "move" ], "type": "string" }, "to": { "type": "string" } }, "required": [ "to", "kind" ], "type": "object" }, "type": "array" } }, "required": [ "state", "revision", "transitions" ], "type": "object" }, { "type": "null" } ] } }, "required": [ "instance_id", "primary_instance_id", "translation_group_id", "model_id", "model_slug", "lang", "label", "slug", "current_version_id", "published_version_id", "workflow" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "EntryUpdate": { "additionalProperties": false, "properties": { "expected_current_version_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale_relations": { "additionalProperties": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, { "additionalProperties": false, "properties": { "set": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" } }, "required": [ "set" ], "type": "object" }, { "additionalProperties": false, "properties": { "connect": { "description": "Items to add, in array order. A plain id goes to the end. `{ id, position }` places it. Positions on a single-target relation are refused (`relation_position_not_ordered`).", "items": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "disconnect": { "description": "Items to remove first.", "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, "move": { "description": "Items already related to reposition, in array order, after disconnect and connect. An item not related is refused (`relation_move_target_missing`).", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id", "position" ], "type": "object" }, "type": "array" } }, "type": "object" } ], "description": "A plain list or `{ set }` replaces the list. `{ connect, disconnect, move }` edits it: disconnect, then connect, then move; the result is the same for the same input." }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "description": "Each language's own lists, for a relation field with different links in each language.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "additionalProperties": {}, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "media": { "additionalProperties": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "crop": { "anyOf": [ { "additionalProperties": false, "properties": { "height": { "maximum": 1, "minimum": 0, "type": "number" }, "width": { "maximum": 1, "minimum": 0, "type": "number" }, "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y", "width", "height" ], "type": "object" }, { "type": "null" } ] }, "focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "relations": { "additionalProperties": { "anyOf": [ { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, { "additionalProperties": false, "properties": { "set": { "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" } }, "required": [ "set" ], "type": "object" }, { "additionalProperties": false, "properties": { "connect": { "description": "Items to add, in array order. A plain id goes to the end. `{ id, position }` places it. Positions on a single-target relation are refused (`relation_position_not_ordered`).", "items": { "anyOf": [ { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id" ], "type": "object" } ] }, "type": "array" }, "disconnect": { "description": "Items to remove first.", "items": { "anyOf": [ { "minLength": 1, "type": "string" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "model", "id" ], "type": "object" } ], "description": "An instance id, or `{ model, id }` naming the target's model slug as well. When `model` is given it must be the target's own model; a field that accepts several models takes targets of each (`relation_target_not_found` otherwise)." }, "type": "array" }, "move": { "description": "Items already related to reposition, in array order, after disconnect and connect. An item not related is refused (`relation_move_target_missing`).", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model": { "minLength": 1, "type": "string" }, "position": { "anyOf": [ { "additionalProperties": false, "properties": { "before": { "minLength": 1, "type": "string" } }, "required": [ "before" ], "type": "object" }, { "additionalProperties": false, "properties": { "after": { "minLength": 1, "type": "string" } }, "required": [ "after" ], "type": "object" }, { "additionalProperties": false, "properties": { "start": { "const": true, "type": "boolean" } }, "required": [ "start" ], "type": "object" }, { "additionalProperties": false, "properties": { "end": { "const": true, "type": "boolean" } }, "required": [ "end" ], "type": "object" } ], "description": "Exactly one of `{ before: id }`, `{ after: id }`, `{ start: true }`, `{ end: true }`. An anchor is an id in the list at that step." } }, "required": [ "id", "position" ], "type": "object" }, "type": "array" } }, "type": "object" } ], "description": "A plain list or `{ set }` replaces the list. `{ connect, disconnect, move }` edits it: disconnect, then connect, then move; the result is the same for the same input." }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "seo": { "additionalProperties": { "anyOf": [ { "additionalProperties": false, "properties": { "canonical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "const": 1, "type": "number" }, "image": { "anyOf": [ { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_id": { "minLength": 1, "type": "string" } }, "required": [ "media_id" ], "type": "object" }, { "type": "null" } ] }, "robots": { "enum": [ "index", "noindex" ], "type": "string" }, "schema_type": { "anyOf": [ { "enum": [ "WebPage", "AboutPage", "ContactPage", "Article" ], "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "format" ], "type": "object" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "slugs": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Each language's own address. `null` on create: no address in that language.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" } }, "required": [ "expected_current_version_id", "locales" ], "type": "object" }, "ErrorBody": { "additionalProperties": {}, "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "error", "reason" ], "type": "object" }, "ExportCreate": { "additionalProperties": false, "properties": { "locale": { "minLength": 1, "type": "string" }, "models": { "items": { "minLength": 1, "type": "string" }, "type": "array" }, "product": { "description": "bundle, content, csv, xlsx or history.", "minLength": 1, "type": "string" } }, "required": [ "product" ], "type": "object" }, "ExportCreatedResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "artifact": { "anyOf": [ { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "filename": { "type": "string" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sha256", "size", "content_type", "filename" ], "type": "object" }, { "type": "null" } ], "description": "The whole export once it is finished, to read with `readExportChunk`; `null` until then." }, "job": { "additionalProperties": false, "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "product": { "type": "string" }, "retention_deadline": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "product", "format", "status", "error", "retention_deadline" ], "type": "object" }, "more": { "description": "Another `advanceExport` would build the next page or finish the export.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "advanceExport", "readExportChunk", "getExportJob" ], "type": "string" }, "type": "array" }, "pages": { "description": "Every page built so far, in order. None is ever replaced.", "items": { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where this page starts; `null` for the first." }, "filename": { "type": "string" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the next page starts; `null` at the last." }, "page": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "readable": { "description": "Its bytes are still kept: every page until the export is finished.", "type": "boolean" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "page", "sha256", "size", "content_type", "filename", "cursor", "next_cursor", "readable" ], "type": "object" }, "type": "array" } }, "required": [ "job", "artifact", "pages", "more", "next_actions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ExportJobResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "artifact": { "anyOf": [ { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "filename": { "type": "string" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sha256", "size", "content_type", "filename" ], "type": "object" }, { "type": "null" } ], "description": "The whole export once it is finished, to read with `readExportChunk`; `null` until then." }, "job": { "additionalProperties": false, "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "product": { "type": "string" }, "retention_deadline": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "product", "format", "status", "error", "retention_deadline" ], "type": "object" }, "more": { "description": "Another `advanceExport` would build the next page or finish the export.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "advanceExport", "readExportChunk", "getExportJob" ], "type": "string" }, "type": "array" }, "pages": { "description": "Every page built so far, in order. None is ever replaced.", "items": { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where this page starts; `null` for the first." }, "filename": { "type": "string" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the next page starts; `null` at the last." }, "page": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "readable": { "description": "Its bytes are still kept: every page until the export is finished.", "type": "boolean" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "page", "sha256", "size", "content_type", "filename", "cursor", "next_cursor", "readable" ], "type": "object" }, "type": "array" } }, "required": [ "job", "artifact", "pages", "more", "next_actions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ExportStateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "artifact": { "anyOf": [ { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "filename": { "type": "string" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "sha256", "size", "content_type", "filename" ], "type": "object" }, { "type": "null" } ], "description": "The whole export once it is finished, to read with `readExportChunk`; `null` until then." }, "job": { "additionalProperties": false, "properties": { "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "product": { "type": "string" }, "retention_deadline": { "type": "string" }, "status": { "type": "string" } }, "required": [ "id", "product", "format", "status", "error", "retention_deadline" ], "type": "object" }, "more": { "description": "Another `advanceExport` would build the next page or finish the export.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "advanceExport", "readExportChunk", "getExportJob" ], "type": "string" }, "type": "array" }, "pages": { "description": "Every page built so far, in order. None is ever replaced.", "items": { "additionalProperties": false, "properties": { "content_type": { "type": "string" }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where this page starts; `null` for the first." }, "filename": { "type": "string" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Where the next page starts; `null` at the last." }, "page": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "readable": { "description": "Its bytes are still kept: every page until the export is finished.", "type": "boolean" }, "sha256": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "page", "sha256", "size", "content_type", "filename", "cursor", "next_cursor", "readable" ], "type": "object" }, "type": "array" } }, "required": [ "job", "artifact", "pages", "more", "next_actions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "HistoryAssignmentSave": { "additionalProperties": false, "properties": { "assignee_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "choice": { "enum": [ "suggested", "chosen", "cleared" ], "type": "string" }, "instance_id": { "minLength": 1, "type": "string" } }, "required": [ "instance_id", "choice" ], "type": "object" }, "HistoryAssignmentsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Read on with this `cursor`; `null` after the last items." }, "status": { "type": "string" }, "totals": { "additionalProperties": {}, "description": "How many items each paged list holds in all, at the same place the list sits: a number per list, an object of numbers for a record of lists.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "status", "totals", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ImportArchivePart": { "description": "One archive part, raw bytes. Every part but the last is exactly 5242880 bytes.", "format": "binary", "type": "string" }, "ImportComplete": { "additionalProperties": false, "properties": { "client_sha256": { "description": "SHA-256 of the whole archive as the client read it. A mismatch is refused.", "pattern": "^[0-9a-fA-F]{64}$", "type": "string" } }, "type": "object" }, "ImportCreate": { "additionalProperties": false, "description": "Name a new source or reuse one by `source_id`, never both.", "properties": { "destination": { "enum": [ "new_site", "existing_site" ], "type": "string" }, "format": { "description": "tar, tar.gz (Strapi), json (legacy Dee Wan file), transfer (.deewan site copy/history) or wxr (WordPress).", "minLength": 1, "type": "string" }, "source": { "additionalProperties": false, "properties": { "label": { "minLength": 1, "type": "string" }, "system": { "minLength": 1, "type": "string" } }, "required": [ "label", "system" ], "type": "object" }, "source_id": { "minLength": 1, "type": "string" } }, "required": [ "format" ], "type": "object" }, "ImportCreatedResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "decision": { "anyOf": [ { "additionalProperties": false, "properties": { "detail": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "kind": { "enum": [ "upload_needed", "mapping_required", "wordpress_mapping_required", "findings_block", "paused", "blocked", "cancel_pending", "undo_refused", "undo_failed" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "kind", "message" ], "type": "object" }, { "type": "null" } ] }, "findings": { "additionalProperties": false, "properties": { "blocking": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "info": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "warning": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "blocking", "warning", "info" ], "type": "object" }, "job": { "additionalProperties": false, "properties": { "created_at": { "type": "string" }, "dry_run_state": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "final_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "plan_revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "progress": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "source": { "anyOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system" ], "type": "object" }, { "type": "null" } ] }, "stage": { "enum": [ "upload", "prepare", "review", "check", "import", "undo", "done" ], "type": "string" }, "status": { "type": "string" }, "undo_state": { "type": "string" }, "updated_at": { "type": "string" }, "upload": { "additionalProperties": false, "properties": { "bytes_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "part_size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "parts_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "type": "string" } }, "required": [ "state", "parts_received", "bytes_received", "part_size" ], "type": "object" } }, "required": [ "id", "status", "stage", "format", "source", "plan_revision", "upload", "progress", "dry_run_state", "undo_state", "final_status", "error", "created_at", "updated_at" ], "type": "object" }, "more": { "description": "Another `advanceImport` would run a step now.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "getImportJob", "uploadImportPart", "completeImportUpload", "advanceImport", "getImportFindings", "getImportMapping", "setImportMapping", "getWordPressReview", "setWordPressMapping", "getHistoryAssignments", "setHistoryAssignment", "getImportPrincipals", "setImportPrincipal", "acceptImportPrincipalSuggestions", "pauseImport", "resumeImport", "cancelImport", "advanceImportUndo", "retryImportUndo", "readImportArtifact" ], "type": "string" }, "type": "array" }, "outcome": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "The scalar fields of what that step answered." }, "step": { "anyOf": [ { "enum": [ "create", "upload", "complete", "prepare", "extract", "inspect", "plan", "mapping", "assignment", "produce", "check", "import", "pause", "resume", "cancel", "undo", "undo_retry" ], "type": "string" }, { "type": "null" } ], "description": "The step this request ran; `null` for none." } }, "required": [ "job", "findings", "decision", "more", "next_actions", "step", "outcome" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ImportFindingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "counts": { "additionalProperties": false, "properties": { "blocking": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "info": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "warning": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "blocking", "warning", "info" ], "type": "object" }, "decision": { "anyOf": [ { "additionalProperties": false, "properties": { "detail": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "kind": { "enum": [ "upload_needed", "mapping_required", "wordpress_mapping_required", "findings_block", "paused", "blocked", "cancel_pending", "undo_refused", "undo_failed" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "kind", "message" ], "type": "object" }, { "type": "null" } ] }, "issues": { "items": { "additionalProperties": false, "properties": { "affected_count": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "code": { "type": "string" }, "field_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locale": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "type": "string" }, "origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pass_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "severity": { "type": "string" }, "source_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "code", "severity", "source_ref", "locale", "field_ref", "message", "affected_count", "origin", "pass_id" ], "type": "object" }, "type": "array" }, "next_actions": { "items": { "enum": [ "getImportJob", "uploadImportPart", "completeImportUpload", "advanceImport", "getImportFindings", "getImportMapping", "setImportMapping", "getWordPressReview", "setWordPressMapping", "getHistoryAssignments", "setHistoryAssignment", "getImportPrincipals", "setImportPrincipal", "acceptImportPrincipalSuggestions", "pauseImport", "resumeImport", "cancelImport", "advanceImportUndo", "retryImportUndo", "readImportArtifact" ], "type": "string" }, "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Read on with this `cursor`; `null` after the last finding." } }, "required": [ "issues", "next_cursor", "counts", "decision", "next_actions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ImportJobListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "artifact": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "dry_run_state": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "final_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "phase": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "progress": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "source": { "anyOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system" ], "type": "object" }, { "type": "null" } ] }, "status": { "type": "string" }, "undo_state": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "status", "phase", "format", "source", "progress", "error", "dry_run_state", "undo_state", "final_status", "artifact", "created_at", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ImportJobResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "decision": { "anyOf": [ { "additionalProperties": false, "properties": { "detail": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "kind": { "enum": [ "upload_needed", "mapping_required", "wordpress_mapping_required", "findings_block", "paused", "blocked", "cancel_pending", "undo_refused", "undo_failed" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "kind", "message" ], "type": "object" }, { "type": "null" } ] }, "findings": { "additionalProperties": false, "properties": { "blocking": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "info": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "warning": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "blocking", "warning", "info" ], "type": "object" }, "job": { "additionalProperties": false, "properties": { "created_at": { "type": "string" }, "dry_run_state": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "final_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "plan_revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "progress": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "source": { "anyOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system" ], "type": "object" }, { "type": "null" } ] }, "stage": { "enum": [ "upload", "prepare", "review", "check", "import", "undo", "done" ], "type": "string" }, "status": { "type": "string" }, "undo_state": { "type": "string" }, "updated_at": { "type": "string" }, "upload": { "additionalProperties": false, "properties": { "bytes_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "part_size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "parts_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "type": "string" } }, "required": [ "state", "parts_received", "bytes_received", "part_size" ], "type": "object" } }, "required": [ "id", "status", "stage", "format", "source", "plan_revision", "upload", "progress", "dry_run_state", "undo_state", "final_status", "error", "created_at", "updated_at" ], "type": "object" }, "more": { "description": "Another `advanceImport` would run a step now.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "getImportJob", "uploadImportPart", "completeImportUpload", "advanceImport", "getImportFindings", "getImportMapping", "setImportMapping", "getWordPressReview", "setWordPressMapping", "getHistoryAssignments", "setHistoryAssignment", "getImportPrincipals", "setImportPrincipal", "acceptImportPrincipalSuggestions", "pauseImport", "resumeImport", "cancelImport", "advanceImportUndo", "retryImportUndo", "readImportArtifact" ], "type": "string" }, "type": "array" }, "outcome": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "The scalar fields of what that step answered." }, "step": { "anyOf": [ { "enum": [ "create", "upload", "complete", "prepare", "extract", "inspect", "plan", "mapping", "assignment", "produce", "check", "import", "pause", "resume", "cancel", "undo", "undo_retry" ], "type": "string" }, { "type": "null" } ], "description": "The step this request ran; `null` for none." } }, "required": [ "job", "findings", "decision", "more", "next_actions", "step", "outcome" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ImportMappingResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Read on with this `cursor`; `null` after the last items." }, "status": { "type": "string" }, "totals": { "additionalProperties": {}, "description": "How many items each paged list holds in all, at the same place the list sits: a number per list, an object of numbers for a record of lists.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "status", "totals", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ImportMappingSave": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "plan": { "additionalProperties": {}, "description": "The Strapi mapping, as `getImportMapping` reads it under `mapping`.", "properties": {}, "type": "object" } }, "required": [ "expected_revision", "plan" ], "type": "object" }, "ImportPrincipalSave": { "additionalProperties": false, "properties": { "ref": { "description": "The principal, as `getImportPrincipals` lists it under `principals[].ref`.", "minLength": 1, "type": "string" }, "user_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "An active member of this site from `members`, or `null` to leave the principal unmapped." } }, "required": [ "ref", "user_id" ], "type": "object" }, "ImportPrincipalsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Read on with this `cursor`; `null` after the last items." }, "status": { "type": "string" }, "totals": { "additionalProperties": {}, "description": "How many items each paged list holds in all, at the same place the list sits: a number per list, an object of numbers for a record of lists.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "status", "totals", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ImportSourceCreate": { "additionalProperties": false, "properties": { "label": { "minLength": 1, "type": "string" }, "system": { "description": "A source system this site may import from, such as strapi5 or wordpress.", "minLength": 1, "type": "string" } }, "required": [ "label", "system" ], "type": "object" }, "ImportSourceListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "created_at": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system", "created_at" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ImportSourceResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "created_at": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system", "created_at" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ImportStateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "decision": { "anyOf": [ { "additionalProperties": false, "properties": { "detail": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "kind": { "enum": [ "upload_needed", "mapping_required", "wordpress_mapping_required", "findings_block", "paused", "blocked", "cancel_pending", "undo_refused", "undo_failed" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "kind", "message" ], "type": "object" }, { "type": "null" } ] }, "findings": { "additionalProperties": false, "properties": { "blocking": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "info": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "warning": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "blocking", "warning", "info" ], "type": "object" }, "job": { "additionalProperties": false, "properties": { "created_at": { "type": "string" }, "dry_run_state": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "final_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "plan_revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "progress": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "source": { "anyOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "system": { "type": "string" } }, "required": [ "id", "label", "system" ], "type": "object" }, { "type": "null" } ] }, "stage": { "enum": [ "upload", "prepare", "review", "check", "import", "undo", "done" ], "type": "string" }, "status": { "type": "string" }, "undo_state": { "type": "string" }, "updated_at": { "type": "string" }, "upload": { "additionalProperties": false, "properties": { "bytes_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "part_size": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "parts_received": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "state": { "type": "string" } }, "required": [ "state", "parts_received", "bytes_received", "part_size" ], "type": "object" } }, "required": [ "id", "status", "stage", "format", "source", "plan_revision", "upload", "progress", "dry_run_state", "undo_state", "final_status", "error", "created_at", "updated_at" ], "type": "object" }, "more": { "description": "Another `advanceImport` would run a step now.", "type": "boolean" }, "next_actions": { "items": { "enum": [ "getImportJob", "uploadImportPart", "completeImportUpload", "advanceImport", "getImportFindings", "getImportMapping", "setImportMapping", "getWordPressReview", "setWordPressMapping", "getHistoryAssignments", "setHistoryAssignment", "getImportPrincipals", "setImportPrincipal", "acceptImportPrincipalSuggestions", "pauseImport", "resumeImport", "cancelImport", "advanceImportUndo", "retryImportUndo", "readImportArtifact" ], "type": "string" }, "type": "array" }, "outcome": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "propertyNames": { "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "The scalar fields of what that step answered." }, "step": { "anyOf": [ { "enum": [ "create", "upload", "complete", "prepare", "extract", "inspect", "plan", "mapping", "assignment", "produce", "check", "import", "pause", "resume", "cancel", "undo", "undo_retry" ], "type": "string" }, { "type": "null" } ], "description": "The step this request ran; `null` for none." } }, "required": [ "job", "findings", "decision", "more", "next_actions", "step", "outcome" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "LanguageFallbackResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "chains": { "anyOf": [ { "additionalProperties": { "items": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "array" }, "description": "Language to the languages a read tries, in order, before the site default. A language left out falls back to the default alone.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Null: unreadable." }, "languages": { "description": "The site’s languages, default first.", "items": { "type": "string" }, "type": "array" }, "policy": { "anyOf": [ { "enum": [ "strict", "fallback_to_default" ], "type": "string" }, { "type": "null" } ], "description": "`strict` shows only content in the language asked for; `fallback_to_default` shows another language instead. Null: unreadable." }, "revisions": { "additionalProperties": false, "properties": { "chains": { "pattern": "^[0-9a-f]{16}$", "type": "string" }, "policy": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "policy", "chains" ], "type": "object" } }, "required": [ "policy", "chains", "languages", "revisions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "LanguageFallbackUpdate": { "additionalProperties": false, "properties": { "chains": { "additionalProperties": { "items": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "array" }, "description": "Replaced whole. Unknown languages, self references, repeats and cycles are refused.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "expected_revisions": { "additionalProperties": false, "properties": { "chains": { "description": "The revision of `chains` this change was made against. A stale one is refused with `settings_changed_concurrently`.", "pattern": "^[0-9a-f]{16}$", "type": "string" }, "policy": { "description": "The revision of `policy` this change was made against. A stale one is refused with `settings_changed_concurrently`.", "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "type": "object" }, "policy": { "enum": [ "strict", "fallback_to_default" ], "type": "string" } }, "required": [ "expected_revisions" ], "type": "object" }, "LanguageFallbackUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "chains": { "anyOf": [ { "additionalProperties": { "items": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "array" }, "description": "Language to the languages a read tries, in order, before the site default. A language left out falls back to the default alone.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, { "type": "null" } ], "description": "Null: unreadable." }, "languages": { "description": "The site’s languages, default first.", "items": { "type": "string" }, "type": "array" }, "policy": { "anyOf": [ { "enum": [ "strict", "fallback_to_default" ], "type": "string" }, { "type": "null" } ], "description": "`strict` shows only content in the language asked for; `fallback_to_default` shows another language instead. Null: unreadable." }, "revisions": { "additionalProperties": false, "properties": { "chains": { "pattern": "^[0-9a-f]{16}$", "type": "string" }, "policy": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "policy", "chains" ], "type": "object" } }, "required": [ "policy", "chains", "languages", "revisions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "LanguageListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "is_default": { "type": "boolean" } }, "required": [ "code", "is_default" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "LocaleAdd": { "additionalProperties": false, "properties": { "lang": { "description": "A language code from `listLanguages`.", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "lang" ], "type": "object" }, "LocaleAddResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "instance_id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translation_group_id": { "minLength": 1, "type": "string" } }, "required": [ "instance_id", "lang", "translation_group_id", "slug" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaDeleteResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "type": "boolean" }, "id": { "minLength": 1, "type": "string" }, "storage_cleanup": { "description": "`pending`: the record is gone but a stored copy could not be removed yet. Nothing references it.", "enum": [ "complete", "pending" ], "type": "string" } }, "required": [ "id", "deleted", "storage_cleanup" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaDuplicate": { "additionalProperties": false, "properties": { "copies": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "error": { "type": "string" }, "existing": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "reason": { "const": "media_duplicate", "type": "string" } }, "required": [ "error", "reason", "existing", "copies" ], "type": "object" }, "MediaFileSettingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "kinds": { "anyOf": [ { "additionalProperties": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "formats": { "description": "The kind's accepted formats: image: png, jpeg, webp, avif, gif, svg; document: pdf, docx, xlsx, pptx, odt, ods, odp, rtf, txt, csv; audio: mp3, m4a, ogg, wav, flac, aac; video: mp4, webm, mov, ogv; file: other. `other` takes any file that is not a program, script or markup, as a download.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "max_bytes": { "description": "1024 to the kind's bound in `limits.kind_max_bytes` (33554432 for images, up to 5000000000 for the rest).", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "enabled", "max_bytes", "formats" ], "type": "object" }, "propertyNames": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "required": [ "image", "document", "audio", "video", "file" ], "type": "object" }, { "type": "null" } ], "description": "Which kinds of file uploads take, each with its size cap. Null: unreadable, and uploads refuse until it is saved again." }, "limits": { "additionalProperties": false, "properties": { "buffered_max_bytes": { "const": 33554432, "description": "The largest file a whole-file upload takes: images, the management API, plugins, imports and transfers.", "type": "number" }, "kind_max_bytes": { "additionalProperties": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "description": "The largest cap each kind may be given.", "propertyNames": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "required": [ "image", "document", "audio", "video", "file" ], "type": "object" }, "min_bytes": { "const": 1024, "type": "number" }, "streamed_max_bytes": { "description": "The largest file one streamed admin upload carries: 100000000 (Cloudflare Free and Pro) unless the deployment declares its plan's larger request body limit in `MEDIA_REQUEST_BODY_LIMIT_BYTES`, at most 5000000000.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "min_bytes", "buffered_max_bytes", "streamed_max_bytes", "kind_max_bytes" ], "type": "object" }, "revision": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "kinds", "limits", "revision" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MediaFileSettingsUpdate": { "additionalProperties": false, "properties": { "expected_revision": { "description": "The revision of the media file setting this change was made against. A stale one is refused with `settings_changed_concurrently`.", "pattern": "^[0-9a-f]{16}$", "type": "string" }, "kinds": { "additionalProperties": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "formats": { "description": "Absent: the kind takes its default formats.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "max_bytes": { "description": "1024 to the kind's bound in `limits.kind_max_bytes` (33554432 for images, up to 5000000000 for the rest).", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "enabled", "max_bytes" ], "type": "object" }, "description": "Replaced whole. A kind left out takes its default. Images stay on. Files already stored are kept.", "propertyNames": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "type": "object" } }, "required": [ "kinds", "expected_revision" ], "type": "object" }, "MediaFileSettingsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "kinds": { "anyOf": [ { "additionalProperties": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "formats": { "description": "The kind's accepted formats: image: png, jpeg, webp, avif, gif, svg; document: pdf, docx, xlsx, pptx, odt, ods, odp, rtf, txt, csv; audio: mp3, m4a, ogg, wav, flac, aac; video: mp4, webm, mov, ogv; file: other. `other` takes any file that is not a program, script or markup, as a download.", "items": { "type": "string" }, "minItems": 1, "type": "array" }, "max_bytes": { "description": "1024 to the kind's bound in `limits.kind_max_bytes` (33554432 for images, up to 5000000000 for the rest).", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "enabled", "max_bytes", "formats" ], "type": "object" }, "propertyNames": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "required": [ "image", "document", "audio", "video", "file" ], "type": "object" }, { "type": "null" } ], "description": "Which kinds of file uploads take, each with its size cap. Null: unreadable, and uploads refuse until it is saved again." }, "limits": { "additionalProperties": false, "properties": { "buffered_max_bytes": { "const": 33554432, "description": "The largest file a whole-file upload takes: images, the management API, plugins, imports and transfers.", "type": "number" }, "kind_max_bytes": { "additionalProperties": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "description": "The largest cap each kind may be given.", "propertyNames": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "required": [ "image", "document", "audio", "video", "file" ], "type": "object" }, "min_bytes": { "const": 1024, "type": "number" }, "streamed_max_bytes": { "description": "The largest file one streamed admin upload carries: 100000000 (Cloudflare Free and Pro) unless the deployment declares its plan's larger request body limit in `MEDIA_REQUEST_BODY_LIMIT_BYTES`, at most 5000000000.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "min_bytes", "buffered_max_bytes", "streamed_max_bytes", "kind_max_bytes" ], "type": "object" }, "revision": { "pattern": "^[0-9a-f]{16}$", "type": "string" } }, "required": [ "kinds", "limits", "revision" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaFolderCreate": { "additionalProperties": false, "properties": { "name": { "description": "1 to 80 characters, unique under its parent whatever its case.", "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Absent or null creates it at the top." } }, "required": [ "name" ], "type": "object" }, "MediaFolderDelete": { "additionalProperties": false, "properties": { "expected_folders": { "description": "The `subtree_folder_count` you confirmed.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "expected_media": { "description": "The `subtree_media_count` you confirmed: the files that become Unfiled.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "expected_revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": [ "expected_revision", "expected_folders", "expected_media" ], "type": "object" }, "MediaFolderDeleteResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted_folders": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "id": { "minLength": 1, "type": "string" }, "unfiled_media": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "deleted_folders", "unfiled_media" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaFolderResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "depth": { "maximum": 5, "minimum": 1, "type": "integer" }, "id": { "minLength": 1, "type": "string" }, "media_count": { "description": "Files directly in this folder.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Null at the top of the tree." }, "revision": { "description": "Send it back to rename, move or delete this folder.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "subtree_folder_count": { "description": "This folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "subtree_media_count": { "description": "Files in this folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "parent_id", "name", "revision", "depth", "media_count", "subtree_folder_count", "subtree_media_count" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaFolderTreeResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "folders": { "description": "Depth first, siblings by name.", "items": { "additionalProperties": false, "properties": { "depth": { "maximum": 5, "minimum": 1, "type": "integer" }, "id": { "minLength": 1, "type": "string" }, "media_count": { "description": "Files directly in this folder.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Null at the top of the tree." }, "revision": { "description": "Send it back to rename, move or delete this folder.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "subtree_folder_count": { "description": "This folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "subtree_media_count": { "description": "Files in this folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "parent_id", "name", "revision", "depth", "media_count", "subtree_folder_count", "subtree_media_count" ], "type": "object" }, "type": "array" }, "limits": { "additionalProperties": false, "properties": { "depth_max": { "const": 5, "type": "number" }, "folders_max": { "const": 500, "type": "number" }, "move_max": { "const": 200, "type": "number" }, "name_max": { "const": 80, "type": "number" } }, "required": [ "name_max", "depth_max", "folders_max", "move_max" ], "type": "object" }, "total": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "unfiled": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "folders", "unfiled", "total", "limits" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MediaFolderUpdate": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "name": { "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Absent keeps the parent; null moves it to the top." } }, "required": [ "expected_revision" ], "type": "object" }, "MediaFolderUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "depth": { "maximum": 5, "minimum": 1, "type": "integer" }, "id": { "minLength": 1, "type": "string" }, "media_count": { "description": "Files directly in this folder.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "name": { "type": "string" }, "parent_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Null at the top of the tree." }, "revision": { "description": "Send it back to rename, move or delete this folder.", "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "subtree_folder_count": { "description": "This folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "subtree_media_count": { "description": "Files in this folder and every folder below it.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" } }, "required": [ "id", "parent_id", "name", "revision", "depth", "media_count", "subtree_folder_count", "subtree_media_count" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaInUse": { "additionalProperties": false, "properties": { "at_least": { "description": "References proven to exist.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "error": { "type": "string" }, "hidden": { "description": "References in content this credential may not read: counted, never described.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "more": { "description": "More than 50 references exist.", "type": "boolean" }, "reason": { "enum": [ "media_in_use", "media_usage_unreadable" ], "type": "string" }, "total": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Every reference, or null when the read was capped or unreadable." }, "unreadable": { "description": "Some content or retained history could not be read, so the counts are not exact.", "type": "boolean" }, "used_by": { "description": "At most 50 references this credential may read.", "items": { "additionalProperties": false, "properties": { "field_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "field_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "in_trash": { "type": "boolean" }, "instance_id": { "minLength": 1, "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "instance_id", "slug", "lang", "status", "model_slug", "model_name", "field_key", "field_label", "in_trash" ], "type": "object" }, "type": "array" } }, "required": [ "error", "reason", "unreadable", "total", "more", "at_least", "hidden", "used_by" ], "type": "object" }, "MediaItemResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MediaListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "MediaMove": { "additionalProperties": false, "properties": { "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Null moves the files to Unfiled." }, "media_ids": { "items": { "minLength": 1, "type": "string" }, "maxItems": 200, "minItems": 1, "type": "array" } }, "required": [ "media_ids", "folder_id" ], "type": "object" }, "MediaMoveResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "media": { "items": { "additionalProperties": false, "properties": { "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "folder_id" ], "type": "object" }, "type": "array" } }, "required": [ "media" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaOriginalListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "byte_length": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "mime_type": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "lang", "url", "mime_type", "byte_length", "width", "height" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "MediaOriginalRemoval": { "additionalProperties": false, "properties": { "expected_object_id": { "minLength": 1, "type": "string" } }, "required": [ "expected_object_id" ], "type": "object" }, "MediaOriginalRemovalResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "removed": { "const": true, "type": "boolean" } }, "required": [ "removed" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaOriginalReplacement": { "additionalProperties": false, "properties": { "expected_object_id": { "description": "Current localized object id. Empty string creates the first original for this language.", "type": "string" }, "file": { "format": "binary", "type": "string" } }, "required": [ "file", "expected_object_id" ], "type": "object" }, "MediaOriginalReplacementResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "byte_length": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "mime_type": { "type": "string" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "lang", "url", "mime_type", "byte_length", "width", "height" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaReplacement": { "additionalProperties": false, "properties": { "alt_texts": { "description": "JSON object: language code to alt text. Absent keeps existing text.", "type": "string" }, "aspectRatio": { "type": "string" }, "default_focal": { "description": "JSON focal point, or null to clear. Absent keeps existing framing.", "type": "string" }, "fetchPriority": { "enum": [ "high", "low", "auto" ], "type": "string" }, "file": { "format": "binary", "type": "string" }, "height": { "type": "string" }, "loading": { "enum": [ "eager", "lazy" ], "type": "string" }, "width": { "type": "string" } }, "required": [ "file" ], "type": "object" }, "MediaReplacementResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaReusedResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" }, "reused": { "const": true, "type": "boolean" } }, "required": [ "data", "reused" ], "type": "object" }, "MediaSourceDuplicate": { "additionalProperties": false, "properties": { "copies": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "error": { "type": "string" }, "existing": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "reason": { "const": "media_duplicate", "type": "string" } }, "required": [ "error", "reason", "existing", "copies" ], "type": "object" }, "MediaSourceImport": { "additionalProperties": false, "properties": { "folder_id": { "description": "The library folder to file the copy in. Absent: Unfiled.", "type": "string" }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "mode": { "description": "`copy` or `reference`, as the source’s `modes` offers. A mode the source does not declare is refused with 422 `media_source_mode_unsupported`. Never inferred.", "enum": [ "copy", "reference" ], "type": "string" }, "on_duplicate": { "description": "When this site already holds the same bytes (`copy`) or a link to the same item (`reference`): `ask` (default) refuses with 409 `media_duplicate`, `use_existing` answers the existing file with 200, `copy` keeps a separate copy.", "enum": [ "ask", "use_existing", "copy" ], "type": "string" } }, "required": [ "item_id", "mode" ], "type": "object" }, "MediaSourceImportResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaSourceListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "installation_id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "modes": { "description": "How a file of this source may be added: `copy` keeps a copy in the library, `reference` links the provider’s delivery URL and keeps no bytes.", "items": { "enum": [ "copy", "reference" ], "type": "string" }, "minItems": 1, "type": "array" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "source_id": { "description": "The source id the plugin’s manifest declares.", "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "source_id", "label", "description", "modes" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "MediaSourcePageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "attribution": { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "license": { "type": "string" }, "license_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_name": { "type": "string" }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url" ], "type": "object" }, "byte_size": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Becomes an image’s alt text in the site’s default language." }, "file_name": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "description": "The source’s own item id. Send it to `importMediaSourceItem`.", "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "mime_type": { "type": "string" }, "thumbnail_url": { "description": "A preview on the plugin’s origin. Load it with no referrer and no credential.", "type": "string" }, "title": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "title", "description", "file_name", "mime_type", "kind", "width", "height", "byte_size", "thumbnail_url", "attribution" ], "type": "object" }, "maxItems": 24, "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Send it as `cursor` for the next page. Null on the last one." } }, "required": [ "items", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MediaSourceReusedResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaUpdate": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "description": "Language code to alt text. Languages left out keep theirs; an empty string clears one.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Images only. Null clears it." }, "fetch_priority": { "enum": [ "high", "low", "auto" ], "type": "string" }, "loading": { "enum": [ "eager", "lazy" ], "type": "string" } }, "type": "object" }, "MediaUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "alt_texts": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "attribution": { "anyOf": [ { "additionalProperties": false, "properties": { "author": { "anyOf": [ { "maxLength": 120, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "author_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "item_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "license": { "maxLength": 80, "minLength": 1, "type": "string" }, "license_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] }, "plugin_id": { "maxLength": 128, "minLength": 1, "type": "string" }, "source_id": { "maxLength": 32, "minLength": 1, "type": "string" }, "source_name": { "maxLength": 80, "minLength": 1, "type": "string" }, "source_url": { "anyOf": [ { "maxLength": 2048, "pattern": "^https:\\/\\/[^\\s]+$", "type": "string" }, { "type": "null" } ] } }, "required": [ "source_name", "author", "author_url", "license", "license_url", "source_url", "plugin_id", "source_id", "item_id" ], "type": "object" }, { "type": "null" } ], "description": "Credit and origin of a file copied from a media source plugin: show it as the file’s credit. Null for files added any other way." }, "created_at": { "type": "string" }, "default_focal": { "anyOf": [ { "additionalProperties": false, "properties": { "x": { "maximum": 1, "minimum": 0, "type": "number" }, "y": { "maximum": 1, "minimum": 0, "type": "number" } }, "required": [ "x", "y" ], "type": "object" }, { "type": "null" } ], "description": "Where new uses of an image start framed, as fractions of the file. Null: the centre." }, "edited_from": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library file this one was edited from (crop, rotate), or null." }, "external": { "description": "True for a file linked from a media source by reference: the provider keeps the bytes and `url` is its delivery URL. Its bytes cannot be replaced or edited here.", "type": "boolean" }, "fetch_priority": { "anyOf": [ { "enum": [ "high", "low", "auto" ], "type": "string" }, { "type": "null" } ] }, "folder_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The library folder holding this file, or null for Unfiled." }, "format": { "type": "string" }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "loading": { "anyOf": [ { "enum": [ "eager", "lazy" ], "type": "string" }, { "type": "null" } ] }, "mime_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "size": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "thumbnail_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "id", "name", "url", "thumbnail_url", "mime_type", "kind", "width", "height", "size", "format", "alt_texts", "created_at", "folder_id", "edited_from", "default_focal", "external", "loading", "fetch_priority", "attribution" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MediaUpload": { "properties": { "alt_texts": { "description": "JSON object: language code to alt text.", "type": "string" }, "edited_from": { "description": "Upload these bytes as an edited copy of this library file. The original is kept. The copy records its origin, takes the original's tags, and its alt text and folder unless this request names them.", "type": "string" }, "file": { "format": "binary", "type": "string" }, "folder_id": { "description": "The library folder to file a new upload in. Absent files it in Unfiled. A reused duplicate stays where it is.", "type": "string" }, "height": { "type": "string" }, "on_duplicate": { "description": "When this site already holds the same bytes: `ask` (default) refuses with 409 `media_duplicate` naming the existing file, `use_existing` answers it with 200 and `reused: true`, `copy` uploads a separate copy.", "enum": [ "ask", "use_existing", "copy" ], "type": "string" }, "width": { "type": "string" } }, "required": [ "file" ], "type": "object" }, "MediaUsageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "at_least": { "description": "References proven to exist.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "hidden": { "description": "References in content this credential may not read: counted, never described.", "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "more": { "description": "More than 50 references exist.", "type": "boolean" }, "total": { "anyOf": [ { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, { "type": "null" } ], "description": "Every reference, or null when the read was capped or unreadable." }, "unreadable": { "description": "Some content or retained history could not be read, so the counts are not exact.", "type": "boolean" }, "used_by": { "description": "At most 50 references this credential may read.", "items": { "additionalProperties": false, "properties": { "field_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "field_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "in_trash": { "type": "boolean" }, "instance_id": { "minLength": 1, "type": "string" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "instance_id", "slug", "lang", "status", "model_slug", "model_name", "field_key", "field_label", "in_trash" ], "type": "object" }, "type": "array" } }, "required": [ "unreadable", "total", "more", "at_least", "hidden", "used_by" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MenuLanguageAdd": { "additionalProperties": false, "properties": { "copy_from": { "anyOf": [ { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, { "type": "null" } ], "description": "Copy this language version’s items, with new item ids; null starts blank." }, "expected_revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these menus come from; null when none is accepted. A save names it." }, "language": { "description": "A language of this site the menu has no version for yet.", "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" } }, "required": [ "expected_revision", "language", "copy_from" ], "type": "object" }, "MenuLanguageAddResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "draft": { "description": "Unaccepted Site Chrome changes: none, kept with this menu written in, or left for a person to re-apply.", "enum": [ "none", "carried", "needs_rebase" ], "type": "string" }, "menu": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "name": { "description": "The language-neutral name people see in Settings.", "type": "string" }, "variants": { "additionalProperties": { "additionalProperties": false, "properties": { "items": { "description": "At most 24 items and 60 items with their children.", "items": { "additionalProperties": false, "properties": { "children": { "description": "At most 12, one level deep.", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] } }, "required": [ "id", "label", "target" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique across the whole language version.", "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] }, { "type": "null" } ], "description": "Null makes the item a heading; it then needs children." } }, "required": [ "id", "label", "target", "children" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "description": "Language code to that language’s own item tree, at most 32. A language without one follows the site’s strict or fallback rule.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "key", "name", "variants" ], "type": "object" }, "placed_in": { "additionalProperties": { "items": { "enum": [ "header", "footer" ], "type": "string" }, "type": "array" }, "description": "Language code to where the site shows this menu in that language’s own placements.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "revision": { "minLength": 1, "type": "string" } }, "required": [ "revision", "menu", "placed_in", "draft" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MenuListResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "menus": { "items": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "name": { "description": "The language-neutral name people see in Settings.", "type": "string" }, "placed_in": { "additionalProperties": { "items": { "enum": [ "header", "footer" ], "type": "string" }, "type": "array" }, "description": "Language code to where the site shows this menu in that language’s own placements.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "variants": { "additionalProperties": { "additionalProperties": false, "properties": { "items": { "description": "At most 24 items and 60 items with their children.", "items": { "additionalProperties": false, "properties": { "children": { "description": "At most 12, one level deep.", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] } }, "required": [ "id", "label", "target" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique across the whole language version.", "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] }, { "type": "null" } ], "description": "Null makes the item a heading; it then needs children." } }, "required": [ "id", "label", "target", "children" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "description": "Language code to that language’s own item tree, at most 32. A language without one follows the site’s strict or fallback rule.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "key", "name", "variants", "placed_in" ], "type": "object" }, "type": "array" }, "revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these menus come from; null when none is accepted. A save names it." } }, "required": [ "revision", "menus" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MenuResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "languages": { "description": "The site’s languages, default first.", "items": { "type": "string" }, "type": "array" }, "live": { "additionalProperties": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" }, "description": "Language version, then item id, to the site languages it shows in today. An item that shows in none is hidden until what it points at is live, or its version is not served.", "propertyNames": { "type": "string" }, "type": "object" }, "menu": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "name": { "description": "The language-neutral name people see in Settings.", "type": "string" }, "variants": { "additionalProperties": { "additionalProperties": false, "properties": { "items": { "description": "At most 24 items and 60 items with their children.", "items": { "additionalProperties": false, "properties": { "children": { "description": "At most 12, one level deep.", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] } }, "required": [ "id", "label", "target" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique across the whole language version.", "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] }, { "type": "null" } ], "description": "Null makes the item a heading; it then needs children." } }, "required": [ "id", "label", "target", "children" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "description": "Language code to that language’s own item tree, at most 32. A language without one follows the site’s strict or fallback rule.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "key", "name", "variants" ], "type": "object" }, "placed_in": { "additionalProperties": { "items": { "enum": [ "header", "footer" ], "type": "string" }, "type": "array" }, "description": "Language code to where the site shows this menu in that language’s own placements.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these menus come from; null when none is accepted. A save names it." }, "served": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": "Site language to the language version it serves today; null when it serves none.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "revision", "menu", "placed_in", "languages", "served", "live" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "MenuSave": { "additionalProperties": false, "properties": { "expected_revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these menus come from; null when none is accepted. A save names it." }, "name": { "type": "string" }, "placements": { "additionalProperties": { "items": { "enum": [ "header", "footer" ], "type": "string" }, "type": "array" }, "description": "Language code to where the menu appears in that language afterwards. A language left out, or the whole field absent, keeps its placements.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "variants": { "additionalProperties": { "additionalProperties": false, "properties": { "items": { "description": "At most 24 items and 60 items with their children.", "items": { "additionalProperties": false, "properties": { "children": { "description": "At most 12, one level deep.", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] } }, "required": [ "id", "label", "target" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique across the whole language version.", "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] }, { "type": "null" } ], "description": "Null makes the item a heading; it then needs children." } }, "required": [ "id", "label", "target", "children" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "description": "Language code to that language’s own item tree, at most 32. A language without one follows the site’s strict or fallback rule.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "expected_revision", "name", "variants" ], "type": "object" }, "MenuSaveResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "draft": { "description": "Unaccepted Site Chrome changes: none, kept with this menu written in, or left for a person to re-apply.", "enum": [ "none", "carried", "needs_rebase" ], "type": "string" }, "menu": { "additionalProperties": false, "properties": { "key": { "minLength": 1, "type": "string" }, "name": { "description": "The language-neutral name people see in Settings.", "type": "string" }, "variants": { "additionalProperties": { "additionalProperties": false, "properties": { "items": { "description": "At most 24 items and 60 items with their children.", "items": { "additionalProperties": false, "properties": { "children": { "description": "At most 12, one level deep.", "items": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] } }, "required": [ "id", "label", "target" ], "type": "object" }, "type": "array" }, "id": { "description": "Unique across the whole language version.", "minLength": 1, "type": "string" }, "label": { "description": "At most 80 characters.", "type": "string" }, "target": { "anyOf": [ { "oneOf": [ { "additionalProperties": false, "properties": { "entry": { "description": "The entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "entry", "type": "string" }, "model": { "minLength": 1, "type": "string" } }, "required": [ "kind", "model", "entry" ], "type": "object" }, { "additionalProperties": false, "description": "The Blog list.", "properties": { "kind": { "const": "blog", "type": "string" } }, "required": [ "kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "entry": { "description": "The category, tag or person entry’s `translation_group_id`.", "minLength": 1, "type": "string" }, "kind": { "const": "archive", "type": "string" }, "role": { "enum": [ "category", "tag", "author" ], "type": "string" } }, "required": [ "kind", "role", "entry" ], "type": "object" }, { "additionalProperties": false, "properties": { "href": { "description": "An https address.", "type": "string" }, "kind": { "const": "url", "type": "string" } }, "required": [ "kind", "href" ], "type": "object" }, { "additionalProperties": false, "properties": { "address": { "type": "string" }, "kind": { "const": "email", "type": "string" } }, "required": [ "kind", "address" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "phone", "type": "string" }, "number": { "type": "string" } }, "required": [ "kind", "number" ], "type": "object" }, { "additionalProperties": false, "properties": { "kind": { "const": "path", "type": "string" }, "path": { "description": "A path on this site.", "type": "string" } }, "required": [ "kind", "path" ], "type": "object" } ] }, { "type": "null" } ], "description": "Null makes the item a heading; it then needs children." } }, "required": [ "id", "label", "target", "children" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" }, "description": "Language code to that language’s own item tree, at most 32. A language without one follows the site’s strict or fallback rule.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" } }, "required": [ "key", "name", "variants" ], "type": "object" }, "placed_in": { "additionalProperties": { "items": { "enum": [ "header", "footer" ], "type": "string" }, "type": "array" }, "description": "Language code to where the site shows this menu in that language’s own placements.", "propertyNames": { "pattern": "^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "type": "object" }, "revision": { "minLength": 1, "type": "string" } }, "required": [ "revision", "menu", "placed_in", "draft" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ModelCreate": { "additionalProperties": false, "properties": { "definition": { "additionalProperties": false, "description": "The whole new model, exactly as the Content Builder applies it.", "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" } }, "required": [ "definition" ], "type": "object" }, "ModelCreateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "created_field_ids": { "description": "The fields this write added, in definition order.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "model_id": { "minLength": 1, "type": "string" }, "renamed_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The slug before this write, when it changed the slug." }, "slug": { "type": "string" } }, "required": [ "model_id", "slug", "created_field_ids", "renamed_from" ], "type": "object" }, "dependents": { "additionalProperties": false, "properties": { "complete": { "description": "False: some grants or scopes still name the old slug. The model write itself is done.", "type": "boolean" } }, "required": [ "complete" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ModelDefinitionApply": { "additionalProperties": false, "properties": { "definition": { "additionalProperties": false, "description": "The complete definition: every field to keep, by id, in order. A field without an id is added; a field left out is removed.", "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "expected_revision": { "description": "The `revision` from `getModel`. The write is refused with `model_changed` once the model changed since.", "pattern": "^[0-9a-f]{64}$", "type": "string" } }, "required": [ "expected_revision", "definition" ], "type": "object" }, "ModelDefinitionApplyResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "created_field_ids": { "description": "The fields this write added, in definition order.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "model_id": { "minLength": 1, "type": "string" }, "renamed_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The slug before this write, when it changed the slug." }, "slug": { "type": "string" } }, "required": [ "model_id", "slug", "created_field_ids", "renamed_from" ], "type": "object" }, "dependents": { "additionalProperties": false, "properties": { "complete": { "description": "False: some grants or scopes still name the old slug. The model write itself is done.", "type": "boolean" } }, "required": [ "complete" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ModelDelete": { "additionalProperties": false, "properties": { "confirm": { "description": "The model id from the path, again. Only a model that holds no content, in its list or in Trash, is deleted.", "minLength": 1, "type": "string" }, "expected_revision": { "description": "The `revision` from `getModel`. The write is refused with `model_changed` once the model changed since.", "pattern": "^[0-9a-f]{64}$", "type": "string" } }, "required": [ "expected_revision", "confirm" ], "type": "object" }, "ModelDeleteResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted": { "const": true, "type": "boolean" }, "model_id": { "minLength": 1, "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "model_id", "slug", "deleted" ], "type": "object" }, "dependents": { "additionalProperties": false, "properties": { "complete": { "description": "False: some grants or scopes still name the old slug. The model write itself is done.", "type": "boolean" } }, "required": [ "complete" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ModelDetailResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "definition": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "revision": { "description": "Changes when the model or any of its fields changes. A direct write names it as `expected_revision`.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "updated_at": { "description": "A proposal for this model names it as `base_updated_at`.", "type": "string" } }, "required": [ "id", "updated_at", "revision", "definition" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "ModelFolderSet": { "additionalProperties": false, "properties": { "folder": { "anyOf": [ { "maxLength": 40, "type": "string" }, { "type": "null" } ], "description": "The content navigation folder, 1 to 40 characters after trimming, grouped without regard to case. Null or blank removes the model from its folder." } }, "required": [ "folder" ], "type": "object" }, "ModelFolderSetResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model_id": { "minLength": 1, "type": "string" }, "slug": { "type": "string" } }, "required": [ "model_id", "slug", "folder" ], "type": "object" }, "dependents": { "additionalProperties": false, "properties": { "complete": { "description": "False: some grants or scopes still name the old slug. The model write itself is done.", "type": "boolean" } }, "required": [ "complete" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ModelListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enable_i18n": { "type": "boolean" }, "fields": { "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "type": "string" }, "label": { "type": "string" }, "private": { "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "type": "string" } }, "required": [ "key", "label", "type", "required", "translatable", "private", "description" ], "type": "object" }, "type": "array" }, "folder": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Admin navigation folder. Display only; never part of the definition, its revision or generated output." }, "id": { "minLength": 1, "type": "string" }, "kind": { "description": "`collection` holds any number of entries; `single` holds one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "id", "slug", "name", "description", "enable_i18n", "kind", "folder", "fields" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ModelUpdate": { "additionalProperties": false, "properties": { "expected_revision": { "description": "The `revision` from `getModel`. The write is refused with `model_changed` once the model changed since.", "pattern": "^[0-9a-f]{64}$", "type": "string" }, "model": { "additionalProperties": false, "description": "Name, slug, description, settings and translation storage. The fields stay as they are.", "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "expected_revision", "model" ], "type": "object" }, "ModelUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "created_field_ids": { "description": "The fields this write added, in definition order.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "model_id": { "minLength": 1, "type": "string" }, "renamed_from": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The slug before this write, when it changed the slug." }, "slug": { "type": "string" } }, "required": [ "model_id", "slug", "created_field_ids", "renamed_from" ], "type": "object" }, "dependents": { "additionalProperties": false, "properties": { "complete": { "description": "False: some grants or scopes still name the old slug. The model write itself is done.", "type": "boolean" } }, "required": [ "complete" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "MoveCommand": { "additionalProperties": false, "properties": { "expected_workflow_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "locale": { "description": "Move this one language only. Absent moves every language of the entry.", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "note": { "maxLength": 2000, "type": "string" }, "to": { "minLength": 1, "type": "string" } }, "required": [ "to", "expected_workflow_revision" ], "type": "object" }, "PageResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" } }, "required": [ "instance_id", "current_version_id" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "PageSave": { "additionalProperties": false, "properties": { "expected_context_versions": {}, "expected_current_version_id": { "minLength": 1, "type": "string" }, "expected_facts_digest": { "pattern": "^[0-9a-f]{64}$", "type": "string" }, "facts": { "additionalProperties": {}, "properties": {}, "type": "object" }, "locale": { "minLength": 1, "type": "string" }, "sections": { "items": { "additionalProperties": {}, "properties": {}, "type": "object" }, "type": "array" }, "seo": { "additionalProperties": { "anyOf": [ { "additionalProperties": false, "properties": { "canonical": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "format": { "const": 1, "type": "number" }, "image": { "anyOf": [ { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "media_id": { "minLength": 1, "type": "string" } }, "required": [ "media_id" ], "type": "object" }, { "type": "null" } ] }, "robots": { "enum": [ "index", "noindex" ], "type": "string" }, "schema_type": { "anyOf": [ { "enum": [ "WebPage", "AboutPage", "ContactPage", "Article" ], "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "format" ], "type": "object" }, { "type": "null" } ] }, "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "expected_current_version_id", "expected_facts_digest", "locale", "sections" ], "type": "object" }, "PageSaveResponse": { "additionalProperties": {}, "properties": { "created": { "type": "boolean" }, "data": { "additionalProperties": {}, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" } }, "required": [ "instance_id", "current_version_id" ], "type": "object" } }, "required": [ "data", "created" ], "type": "object" }, "PageTranslationStart": { "additionalProperties": false, "properties": { "expected_current_version_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "locale": { "description": "The language to start. It must hold no page yet: a language of this page, or a language configured for the site that this page does not have, which is added in the same write.", "minLength": 1, "type": "string" }, "source": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "Another language of this page to copy, with new section ids and its shared-section references kept, or `null` for a blank translation." } }, "required": [ "locale", "source", "expected_current_version_id" ], "type": "object" }, "PageTranslationStartResponse": { "additionalProperties": {}, "properties": { "created": { "type": "boolean" }, "data": { "additionalProperties": {}, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" } }, "required": [ "instance_id", "current_version_id" ], "type": "object" } }, "required": [ "data", "created" ], "type": "object" }, "PluginContentActionListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "installation_id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "model_ids": { "description": "Models it may open on: granted to the plugin and readable by this credential.", "items": { "type": "string" }, "type": "array" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "action", "label", "model_ids", "mcp_tool" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PluginLaunchResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "description": "ISO time after which the link is refused. The link also works only once.", "type": "string" }, "installation_id": { "minLength": 1, "type": "string" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "next_step": { "const": "A person opens url before expires_at. Nothing has run in the plugin; it acts only after the person opens the link.", "type": "string" }, "outcome": { "const": "launch_created", "type": "string" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "single_use": { "const": true, "type": "boolean" }, "url": { "description": "Opens the plugin as the credential’s person. Carries a one-time launch code and nothing else secret.", "type": "string" }, "view": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "outcome", "url", "expires_at", "single_use", "installation_id", "plugin_id", "plugin_name", "view", "action", "instance_id", "next_step" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "PluginListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "content_actions": { "items": { "additionalProperties": false, "properties": { "action": { "type": "string" }, "installation_id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "model_ids": { "description": "Models it may open on: granted to the plugin and readable by this credential.", "items": { "type": "string" }, "type": "array" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "action", "label", "model_ids", "mcp_tool" ], "type": "object" }, "type": "array" }, "installation_id": { "minLength": 1, "type": "string" }, "launchable": { "description": "Active with a valid stored manifest. Only then are views and actions listed, and only those this credential could open now: a view needs a granted model its person reads, own entries included; an action needs a granted model it reads.", "type": "boolean" }, "manage_views": { "items": { "additionalProperties": false, "properties": { "installation_id": { "minLength": 1, "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "view": { "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "view", "mcp_tool" ], "type": "object" }, "type": "array" }, "operations": { "description": "Operations this credential may run now. Each runs in the plugin and answers a result.", "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "destructive": { "description": "It may remove or overwrite something. Ask a person before running it.", "type": "boolean" }, "input": { "description": "The form fields as the plugin manifest declares them (plugin protocol `operations[].input`).", "items": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "type": "array" }, "input_schema": { "additionalProperties": {}, "description": "JSON Schema of `input` in the invoke body.", "propertyNames": { "type": "string" }, "type": "object" }, "installation_id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "model_ids": { "description": "For an entry operation: the models it may run on, granted to the plugin and allowed to this credential. Empty for a site operation.", "items": { "type": "string" }, "type": "array" }, "operation": { "type": "string" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "result": { "description": "The result components a completed run may use.", "items": { "enum": [ "text", "rows", "links", "json" ], "type": "string" }, "type": "array" }, "scope": { "description": "`site` runs without an entry. `entry` runs on one entry and needs instance_id.", "enum": [ "site", "entry" ], "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "operation", "label", "description", "scope", "destructive", "input", "input_schema", "result", "model_ids", "mcp_tool" ], "type": "object" }, "type": "array" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "plugin_version": { "type": "string" }, "policies": { "description": "Content policies the plugin declares and the mode Settings → Plugins set for each. They are asked by every write of their kind; a `save` or `restore` policy may transform the content it is asked about.", "items": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "kind": { "enum": [ "save", "restore", "delete", "publish", "unpublish", "transition" ], "type": "string" }, "label": { "type": "string" }, "mode": { "enum": [ "warn", "required" ], "type": "string" } }, "required": [ "id", "label", "kind", "mode" ], "type": "object" }, "type": "array" }, "state": { "enum": [ "active", "disabled" ], "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "plugin_version", "state", "launchable", "manage_views", "content_actions", "operations", "policies" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PluginManageViewListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "installation_id": { "minLength": 1, "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "view": { "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "view", "mcp_tool" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PluginOperationInvoke": { "additionalProperties": false, "properties": { "input": { "additionalProperties": {}, "description": "Values for the operation’s fields. Closed: an unknown key is refused.", "propertyNames": { "type": "string" }, "type": "object" }, "instance_id": { "description": "The entry, for an entry operation. Absent for a site operation.", "maxLength": 64, "minLength": 1, "type": "string" } }, "type": "object" }, "PluginOperationListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "destructive": { "description": "It may remove or overwrite something. Ask a person before running it.", "type": "boolean" }, "input": { "description": "The form fields as the plugin manifest declares them (plugin protocol `operations[].input`).", "items": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "type": "array" }, "input_schema": { "additionalProperties": {}, "description": "JSON Schema of `input` in the invoke body.", "propertyNames": { "type": "string" }, "type": "object" }, "installation_id": { "minLength": 1, "type": "string" }, "label": { "type": "string" }, "mcp_tool": { "additionalProperties": false, "description": "The MCP tool this launch is offered as. A name that two launches, or a launch and a core tool, normalize to is listed for none of them.", "properties": { "listed": { "type": "boolean" }, "name": { "type": "string" }, "omitted_because": { "anyOf": [ { "enum": [ "name_collision", "name_too_long" ], "type": "string" }, { "type": "null" } ] } }, "required": [ "name", "listed", "omitted_because" ], "type": "object" }, "model_ids": { "description": "For an entry operation: the models it may run on, granted to the plugin and allowed to this credential. Empty for a site operation.", "items": { "type": "string" }, "type": "array" }, "operation": { "type": "string" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "result": { "description": "The result components a completed run may use.", "items": { "enum": [ "text", "rows", "links", "json" ], "type": "string" }, "type": "array" }, "scope": { "description": "`site` runs without an entry. `entry` runs on one entry and needs instance_id.", "enum": [ "site", "entry" ], "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "operation", "label", "description", "scope", "destructive", "input", "input_schema", "result", "model_ids", "mcp_tool" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "PluginOperationRunResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "installation_id": { "minLength": 1, "type": "string" }, "instance_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "invocation_id": { "type": "string" }, "operation": { "type": "string" }, "outcome": { "const": "completed", "type": "string" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "result": { "additionalProperties": false, "properties": { "blocks": { "items": { "additionalProperties": {}, "description": "text {text}; rows {title?, rows: [{key, value}]}; links {links: [{label, url}]} with https URLs only; json {name, value}, a download. Plugin protocol `$defs/operation_result`.", "properties": { "kind": { "enum": [ "text", "rows", "links", "json" ], "type": "string" } }, "required": [ "kind" ], "type": "object" }, "type": "array" } }, "required": [ "blocks" ], "type": "object" } }, "required": [ "invocation_id", "installation_id", "plugin_id", "plugin_name", "operation", "instance_id", "outcome", "result" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "ProposalCreate": { "additionalProperties": false, "properties": { "base_version_id": { "minLength": 1, "type": "string" }, "fields": { "additionalProperties": {}, "propertyNames": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": "object" }, "note": { "maxLength": 2000, "type": "string" } }, "required": [ "base_version_id", "fields" ], "type": "object" }, "ProposalListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "applied_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_version_id": { "minLength": 1, "type": "string" }, "created_at": { "type": "string" }, "fields": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "id": { "minLength": 1, "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_fields": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "default": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "source": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "const": "management", "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "const": "ai", "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "description": "The plugin installation id.", "minLength": 1, "type": "string" }, "kind": { "const": "plugin", "type": "string" }, "label": { "description": "The plugin name.", "type": "string" }, "requested_by": { "description": "The email of the person the plugin acted for.", "type": "string" } }, "required": [ "kind", "id", "label", "requested_by" ], "type": "object" } ] }, "state": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } }, "required": [ "id", "revision", "instance_id", "lang", "base_version_id", "fields", "note", "source", "state", "applied_version_id", "created_at", "resolved_at" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "ProposalResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "applied_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "base_version_id": { "minLength": 1, "type": "string" }, "created_at": { "type": "string" }, "fields": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "id": { "minLength": 1, "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "lang": { "type": "string" }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "original_fields": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "default": 0, "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "source": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "const": "management", "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "const": "ai", "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "description": "The plugin installation id.", "minLength": 1, "type": "string" }, "kind": { "const": "plugin", "type": "string" }, "label": { "description": "The plugin name.", "type": "string" }, "requested_by": { "description": "The email of the person the plugin acted for.", "type": "string" } }, "required": [ "kind", "id", "label", "requested_by" ], "type": "object" } ] }, "state": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } }, "required": [ "id", "revision", "instance_id", "lang", "base_version_id", "fields", "note", "source", "state", "applied_version_id", "created_at", "resolved_at" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "PublishCommand": { "additionalProperties": false, "properties": { "expected_current_version_id": { "minLength": 1, "type": "string" }, "expected_workflow_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "locale": { "description": "Move this one language only. Absent moves every language of the entry.", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "note": { "maxLength": 2000, "type": "string" }, "to": { "minLength": 1, "type": "string" } }, "required": [ "to", "expected_workflow_revision", "expected_current_version_id" ], "type": "object" }, "PurgeCommand": { "additionalProperties": false, "properties": { "confirm": { "description": "The entry id from the path, again. Deleting permanently cannot be undone.", "minLength": 1, "type": "string" } }, "required": [ "confirm" ], "type": "object" }, "PurgeResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "comments_deleted": { "description": "Visitor comments deleted with the item.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "instance_id": { "minLength": 1, "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "scope": { "enum": [ "entry", "language" ], "type": "string" } }, "required": [ "instance_id", "scope", "languages", "comments_deleted", "policy_results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "RedirectReviewRequest": { "additionalProperties": false, "properties": { "redirects": { "description": "Replaced whole, in order.", "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "match": { "enum": [ "exact", "pattern" ], "type": "string" }, "status": { "enum": [ 301, 302, 307, 308, 410, 451 ], "type": "number" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A site path or an https address for 301, 302, 307 and 308; null for 410 and 451." } }, "required": [ "id", "from", "match", "status", "to" ], "type": "object" }, "type": "array" } }, "required": [ "redirects" ], "type": "object" }, "RedirectReviewResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "digest": { "type": "string" }, "patterns": { "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "live_inside": { "description": "Live addresses the pattern covers. They keep serving their page.", "items": { "additionalProperties": false, "properties": { "holder": { "type": "string" }, "path": { "type": "string" } }, "required": [ "path", "holder" ], "type": "object" }, "type": "array" } }, "required": [ "id", "from", "live_inside" ], "type": "object" }, "type": "array" } }, "required": [ "digest", "patterns" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "RelateCommand": { "additionalProperties": false, "properties": { "connect": { "description": "Linked entries to add.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "disconnect": { "description": "Linked entries to remove. 1 to 10 terms in all, none in both lists.", "items": { "minLength": 1, "type": "string" }, "type": "array" }, "expected_versions": { "additionalProperties": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "description": "Every id in `ids` mapped to the current version it replaces.", "propertyNames": { "minLength": 1, "type": "string" }, "type": "object" }, "field": { "description": "The key of a many-to-many relation field every entry has.", "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "ids": { "description": "The entries whose list changes, 1 to 25.", "items": { "minLength": 1, "type": "string" }, "maxItems": 25, "minItems": 1, "type": "array" } }, "required": [ "ids", "field", "expected_versions" ], "type": "object" }, "RelateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "action": { "const": "relate", "type": "string" }, "results": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "outcome": { "const": "done", "type": "string" }, "status": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "outcome", "status" ], "type": "object" }, { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "outcome": { "const": "unchanged", "type": "string" } }, "required": [ "id", "outcome" ], "type": "object" }, { "additionalProperties": false, "properties": { "by": { "minLength": 1, "type": "string" }, "id": { "minLength": 1, "type": "string" }, "outcome": { "const": "covered", "type": "string" } }, "required": [ "id", "outcome", "by" ], "type": "object" }, { "additionalProperties": false, "properties": { "count": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "dependents": {}, "detail": {}, "id": { "minLength": 1, "type": "string" }, "outcome": { "const": "refused", "type": "string" }, "reason": { "type": "string" }, "status": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "outcome", "status", "reason" ], "type": "object" } ] }, "type": "array" } }, "required": [ "action", "results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "RelatedFromChange": { "additionalProperties": false, "properties": { "action": { "enum": [ "add", "remove" ], "type": "string" }, "expected_source_version_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The source’s `version_id` from `getRelatedFrom`." }, "field_id": { "description": "A relation field from `getRelatedFrom` whose target is this entry’s model.", "minLength": 1, "type": "string" }, "replace_target_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "For a to-one field that points elsewhere: the target it points at now, from the `related_from_replace_unconfirmed` refusal. Confirms that exact replacement." }, "source_id": { "minLength": 1, "type": "string" } }, "required": [ "field_id", "source_id", "action", "expected_source_version_id" ], "type": "object" }, "RelatedFromChangeResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "outcome": { "enum": [ "saved", "unchanged" ], "type": "string" }, "related_from": { "additionalProperties": false, "properties": { "groups": { "items": { "additionalProperties": false, "properties": { "can_add": { "description": "The credential may update some entry of the source model.", "type": "boolean" }, "field_id": { "minLength": 1, "type": "string" }, "field_key": { "type": "string" }, "field_label": { "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "model_name": { "type": "string" }, "model_slug": { "type": "string" }, "relation_type": { "enum": [ "oneToOne", "oneToMany", "manyToOne", "manyToMany" ], "type": "string" }, "sources": { "items": { "additionalProperties": false, "properties": { "can_change": { "type": "boolean" }, "draft": { "type": "boolean" }, "in_trash": { "type": "boolean" }, "instance_id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source’s display value; null when it has none or is not readable." }, "lang": { "type": "string" }, "live": { "type": "boolean" }, "readable": { "type": "boolean" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source’s current version, which a change names." } }, "required": [ "instance_id", "slug", "label", "lang", "readable", "live", "draft", "in_trash", "version_id", "can_change" ], "type": "object" }, "type": "array" } }, "required": [ "field_id", "field_key", "field_label", "relation_type", "model_id", "model_slug", "model_name", "can_add", "sources" ], "type": "object" }, "type": "array" } }, "required": [ "groups" ], "type": "object" }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source’s new current version when saved." } }, "required": [ "outcome", "version_id", "related_from" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "RelatedFromResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "groups": { "items": { "additionalProperties": false, "properties": { "can_add": { "description": "The credential may update some entry of the source model.", "type": "boolean" }, "field_id": { "minLength": 1, "type": "string" }, "field_key": { "type": "string" }, "field_label": { "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "model_name": { "type": "string" }, "model_slug": { "type": "string" }, "relation_type": { "enum": [ "oneToOne", "oneToMany", "manyToOne", "manyToMany" ], "type": "string" }, "sources": { "items": { "additionalProperties": false, "properties": { "can_change": { "type": "boolean" }, "draft": { "type": "boolean" }, "in_trash": { "type": "boolean" }, "instance_id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source’s display value; null when it has none or is not readable." }, "lang": { "type": "string" }, "live": { "type": "boolean" }, "readable": { "type": "boolean" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The source’s current version, which a change names." } }, "required": [ "instance_id", "slug", "label", "lang", "readable", "live", "draft", "in_trash", "version_id", "can_change" ], "type": "object" }, "type": "array" } }, "required": [ "field_id", "field_key", "field_label", "relation_type", "model_id", "model_slug", "model_name", "can_add", "sources" ], "type": "object" }, "type": "array" } }, "required": [ "groups" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "RichBlockField": { "oneOf": [ { "additionalProperties": false, "properties": { "control": { "const": "text", "type": "string" }, "default": { "maxLength": 10000, "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "required": { "type": "boolean" }, "validation": { "additionalProperties": false, "properties": { "max_length": { "maximum": 10000, "minimum": 1, "type": "integer" }, "min_length": { "maximum": 10000, "minimum": 0, "type": "integer" } }, "type": "object" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "rich_text", "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "textarea", "type": "string" }, "default": { "maxLength": 10000, "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "required": { "type": "boolean" }, "validation": { "additionalProperties": false, "properties": { "max_length": { "maximum": 10000, "minimum": 1, "type": "integer" }, "min_length": { "maximum": 10000, "minimum": 0, "type": "integer" } }, "type": "object" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "url", "type": "string" }, "default": { "maxLength": 2048, "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "required": { "type": "boolean" }, "validation": { "additionalProperties": false, "properties": { "max_length": { "maximum": 2048, "minimum": 1, "type": "integer" } }, "type": "object" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "number", "type": "string" }, "default": { "type": "number" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "required": { "type": "boolean" }, "validation": { "additionalProperties": false, "properties": { "integer": { "type": "boolean" }, "max": { "type": "number" }, "min": { "type": "number" } }, "type": "object" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "boolean", "type": "string" }, "default": { "type": "boolean" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" } }, "required": [ "key", "label", "control" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "select", "type": "string" }, "default": { "maxLength": 64, "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "options": { "items": { "additionalProperties": false, "properties": { "label": { "maxLength": 64, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "value": { "maxLength": 64, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" } }, "required": [ "value", "label" ], "type": "object" }, "maxItems": 50, "minItems": 1, "type": "array" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "control", "options" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "media", "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "media_kind": { "enum": [ "image", "document", "audio", "video", "file" ], "type": "string" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "control", "media_kind" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "relation", "type": "string" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "models": { "items": { "maxLength": 128, "minLength": 1, "type": "string" }, "maxItems": 16, "minItems": 1, "type": "array" }, "multiple": { "type": "boolean" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "control", "models" ], "type": "object" }, { "additionalProperties": false, "properties": { "control": { "const": "group", "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/RichBlockField" }, "maxItems": 24, "minItems": 1, "type": "array" }, "help_text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "key": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "max_items": { "maximum": 50, "minimum": 1, "type": "integer" }, "repeatable": { "type": "boolean" }, "required": { "type": "boolean" } }, "required": [ "key", "label", "control", "fields" ], "type": "object" } ] }, "RichBlockRenderNode": { "anyOf": [ { "additionalProperties": false, "properties": { "children": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "type": "array" }, "group": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "group", "children" ], "type": "object" }, { "additionalProperties": false, "properties": { "children": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "type": "array" }, "each": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "each", "children" ], "type": "object" }, { "additionalProperties": false, "description": "Literal words, escaped.", "properties": { "text": { "maxLength": 200, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" } }, "required": [ "text" ], "type": "object" }, { "additionalProperties": false, "description": "A field’s value as escaped text; a select shows its option label.", "properties": { "field": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "property": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "field" ], "type": "object" }, { "additionalProperties": false, "description": "Children shown only while the field is filled (or equals `equals`).", "properties": { "children": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "type": "array" }, "equals": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "when": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "when", "children" ], "type": "object" }, { "additionalProperties": false, "description": "A link to a url or media field. Without a usable address only the children render.", "properties": { "children": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "type": "array" }, "element": { "const": "a", "type": "string" }, "href": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "element", "href" ], "type": "object" }, { "additionalProperties": false, "description": "An image media field; `alt` names a text field.", "properties": { "alt": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "element": { "const": "img", "type": "string" }, "src": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "element", "src" ], "type": "object" }, { "additionalProperties": false, "properties": { "children": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "type": "array" }, "element": { "enum": [ "div", "section", "aside", "p", "span", "strong", "em", "small", "h2", "h3", "h4", "blockquote", "ul", "ol", "li", "figure", "figcaption", "hr", "br" ], "type": "string" } }, "required": [ "element" ], "type": "object" } ], "description": "One node of a host-interpreted render tree." }, "RichBlockSourceListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "definitions": { "items": { "additionalProperties": false, "properties": { "description": { "maxLength": 160, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "fields": { "items": { "$ref": "#/components/schemas/RichBlockField" }, "maxItems": 24, "minItems": 1, "type": "array" }, "inline": { "type": "boolean" }, "label": { "maxLength": 40, "minLength": 1, "pattern": "^[^\\p{Cc}<>]+$", "type": "string" }, "migrations": { "description": "Steps from one version to the next. A version without an entry carries values unchanged.", "items": { "additionalProperties": false, "properties": { "from": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "steps": { "items": { "oneOf": [ { "additionalProperties": false, "properties": { "from": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "op": { "const": "rename", "type": "string" }, "to": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "op", "from", "to" ], "type": "object" }, { "additionalProperties": false, "properties": { "field": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "op": { "const": "set_default", "type": "string" }, "value": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": [ "op", "field", "value" ], "type": "object" }, { "additionalProperties": false, "properties": { "field": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "op": { "const": "drop", "type": "string" } }, "required": [ "op", "field" ], "type": "object" } ] }, "maxItems": 24, "minItems": 1, "type": "array" }, "to": { "maximum": 9007199254740991, "minimum": 2, "type": "integer" } }, "required": [ "from", "to", "steps" ], "type": "object" }, "maxItems": 100, "type": "array" }, "name": { "description": "Stored as `/`.", "pattern": "^[a-z][a-z0-9_-]{0,31}$", "type": "string" }, "plugin": { "type": "string" }, "preview": { "additionalProperties": { "anyOf": [ { "maxLength": 10000, "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "description": "Sample values the insert menu previews with. No media.", "propertyNames": { "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" }, "type": "object" }, "render": { "additionalProperties": false, "description": "Host-interpreted render tree. Without it renderers show the block as unsupported.", "properties": { "nodes": { "items": { "$ref": "#/components/schemas/RichBlockRenderNode" }, "minItems": 1, "type": "array" }, "tone": { "description": "A select field whose value (neutral, info, success, warning, danger) tints the block.", "pattern": "^[a-z][a-z0-9_]{0,31}$", "type": "string" } }, "required": [ "nodes" ], "type": "object" }, "type": { "description": "`/`: what a stored block names in `data-type`.", "type": "string" }, "version": { "description": "Raise it when fields change; stored blocks keep the version they were saved with.", "maximum": 1000, "minimum": 1, "type": "integer" } }, "required": [ "name", "version", "label", "fields", "type", "plugin" ], "type": "object" }, "type": "array" }, "installation_id": { "type": "string" }, "plugin_id": { "type": "string" }, "plugin_name": { "type": "string" }, "state": { "description": "Only an active plugin’s blocks can be added or changed in content.", "enum": [ "active", "disabled" ], "type": "string" } }, "required": [ "installation_id", "plugin_id", "plugin_name", "state", "definitions" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "RoleCreate": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ] }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "permissions": { "additionalProperties": false, "description": "A role permission set, the shape Settings → Roles saves.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "required": [ "name", "permissions" ], "type": "object" }, "RoleCreateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "is_system": { "description": "A seeded role: editable, never renamed or deleted.", "type": "boolean" }, "name": { "type": "string" }, "permissions": { "additionalProperties": false, "description": "A role permission set, the shape Settings → Roles saves.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "required": [ "id", "name", "description", "is_system", "permissions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "RoleDeleteResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" } }, "required": [ "id" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "RoleListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "is_system": { "description": "A seeded role: editable, never renamed or deleted.", "type": "boolean" }, "name": { "type": "string" }, "permissions": { "additionalProperties": false, "description": "A role permission set, the shape Settings → Roles saves.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "required": [ "id", "name", "description", "is_system", "permissions" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "RoleResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "is_system": { "description": "A seeded role: editable, never renamed or deleted.", "type": "boolean" }, "name": { "type": "string" }, "permissions": { "additionalProperties": false, "description": "A role permission set, the shape Settings → Roles saves.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "required": [ "id", "name", "description", "is_system", "permissions" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "RoleUpdate": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "maxLength": 500, "type": "string" }, { "type": "null" } ] }, "name": { "description": "Refused for a seeded role.", "maxLength": 64, "minLength": 1, "type": "string" }, "permissions": { "additionalProperties": false, "description": "Replaces the whole set. Omitted keeps it.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "type": "object" }, "RoleUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "minLength": 1, "type": "string" }, "is_system": { "description": "A seeded role: editable, never renamed or deleted.", "type": "boolean" }, "name": { "type": "string" }, "permissions": { "additionalProperties": false, "description": "A role permission set, the shape Settings → Roles saves.", "properties": { "limits": { "additionalProperties": { "additionalProperties": false, "properties": { "fields": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "`read` and `write` (each optionally `:own`): field keys, `seo` and `slug` included, or `*`.", "propertyNames": { "type": "string" }, "type": "object" }, "locales": { "additionalProperties": { "anyOf": [ { "const": "*", "type": "string" }, { "items": { "type": "string" }, "type": "array" } ] }, "description": "read, create, update, delete, restore, review, publish and unpublish (each optionally `:own`): language codes or `*`.", "propertyNames": { "type": "string" }, "type": "object" } }, "type": "object" }, "description": "Field and language narrowing by model slug or `*`. Absent narrows nothing.", "propertyNames": { "type": "string" }, "type": "object" }, "models": { "anyOf": [ { "const": "*", "type": "string" }, { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "type": "string" }, "type": "object" } ], "description": "Model slug (or `*`) to actions: create, read, update, delete, each optionally `:own`, or `*`." }, "system": { "description": "Site capabilities, for example `content:publish`.", "items": { "type": "string" }, "type": "array" } }, "required": [ "models", "system" ], "type": "object" } }, "required": [ "id", "name", "description", "is_system", "permissions" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "SaveResultResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "current_version_id": { "minLength": 1, "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "locales": { "additionalProperties": { "type": "string" }, "propertyNames": { "type": "string" }, "type": "object" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "replayed": { "type": "boolean" }, "slugs": { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "propertyNames": { "type": "string" }, "type": "object" }, "translation_group_id": { "minLength": 1, "type": "string" }, "version": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "version_number": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "version_number" ], "type": "object" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "instance_id", "primary_instance_id", "translation_group_id", "version", "current_version_id", "published_version_id", "slugs", "locales", "warnings", "policy_results" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SchemaProposalCreate": { "oneOf": [ { "additionalProperties": false, "properties": { "definition": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "mode": { "const": "create", "type": "string" }, "note": { "maxLength": 500, "type": "string" } }, "required": [ "mode", "definition" ], "type": "object" }, { "additionalProperties": false, "properties": { "base_updated_at": { "description": "The model `updated_at` from `getModel`.", "minLength": 1, "type": "string" }, "definition": { "additionalProperties": false, "description": "The complete definition: every field to keep, by id. A field left out is removed.", "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "mode": { "const": "update", "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "note": { "maxLength": 500, "type": "string" } }, "required": [ "mode", "model_id", "base_updated_at", "definition" ], "type": "object" } ] }, "SchemaProposalListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "base_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changes": { "description": "What blocked this change for existing content when it was proposed. A person sees the check again before applying.", "items": { "additionalProperties": false, "properties": { "affected_count": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "field": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "samples": { "items": { "type": "string" }, "type": "array" }, "severity": { "const": "blocking", "type": "string" }, "suggestion": { "type": "string" } }, "required": [ "severity", "kind", "field", "message", "affected_count" ], "type": "object" }, "type": "array" }, "created_at": { "type": "string" }, "definition": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "mode": { "enum": [ "create", "update" ], "type": "string" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Null for a new model until a person applies it." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "management", "promotion" ], "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, "stale": { "description": "The model changed after the proposal was made. It can only be dismissed.", "type": "boolean" }, "state": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } }, "required": [ "id", "mode", "model_id", "base_updated_at", "definition", "changes", "note", "source", "state", "stale", "created_at", "resolved_at" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "SchemaProposalReadResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "base_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changes": { "description": "What blocked this change for existing content when it was proposed. A person sees the check again before applying.", "items": { "additionalProperties": false, "properties": { "affected_count": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "field": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "samples": { "items": { "type": "string" }, "type": "array" }, "severity": { "const": "blocking", "type": "string" }, "suggestion": { "type": "string" } }, "required": [ "severity", "kind", "field", "message", "affected_count" ], "type": "object" }, "type": "array" }, "created_at": { "type": "string" }, "definition": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "mode": { "enum": [ "create", "update" ], "type": "string" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Null for a new model until a person applies it." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "management", "promotion" ], "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, "stale": { "description": "The model changed after the proposal was made. It can only be dismissed.", "type": "boolean" }, "state": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } }, "required": [ "id", "mode", "model_id", "base_updated_at", "definition", "changes", "note", "source", "state", "stale", "created_at", "resolved_at" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SchemaProposalResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "base_updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "changes": { "description": "What blocked this change for existing content when it was proposed. A person sees the check again before applying.", "items": { "additionalProperties": false, "properties": { "affected_count": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "field": { "type": "string" }, "kind": { "type": "string" }, "message": { "type": "string" }, "samples": { "items": { "type": "string" }, "type": "array" }, "severity": { "const": "blocking", "type": "string" }, "suggestion": { "type": "string" } }, "required": [ "severity", "kind", "field", "message", "affected_count" ], "type": "object" }, "type": "array" }, "created_at": { "type": "string" }, "definition": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "config": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Type settings, as the Content Builder stores them." }, "derived": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. A computed field rule." }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "description": "The field id from `getModel`. Absent adds a new field.", "minLength": 1, "type": "string" }, "key": { "minLength": 1, "type": "string" }, "label": { "minLength": 1, "type": "string" }, "private": { "description": "Kept for editors, history and transfer; never served publicly. Absent on an existing field keeps it as stored.", "type": "boolean" }, "required": { "type": "boolean" }, "translatable": { "type": "boolean" }, "type": { "minLength": 1, "type": "string" }, "ui": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Editor placement." }, "validation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Validation rules." } }, "required": [ "key", "label", "type" ], "type": "object" }, "maxItems": 200, "type": "array" }, "model": { "additionalProperties": false, "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "enableI18n": { "type": "boolean" }, "kind": { "description": "Absent keeps the stored kind (a new model is a collection). A collection becomes single only while it holds at most one entry, counting Trash.", "enum": [ "collection", "single" ], "type": "string" }, "name": { "minLength": 1, "type": "string" }, "settings": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "JSON text. Model settings." }, "slug": { "minLength": 1, "type": "string" } }, "required": [ "name", "slug", "enableI18n" ], "type": "object" } }, "required": [ "model", "fields" ], "type": "object" }, "id": { "minLength": 1, "type": "string" }, "mode": { "enum": [ "create", "update" ], "type": "string" }, "model_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Null for a new model until a person applies it." }, "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "resolved_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "management", "promotion" ], "type": "string" }, "label": { "type": "string" } }, "required": [ "kind", "id", "label" ], "type": "object" }, "stale": { "description": "The model changed after the proposal was made. It can only be dismissed.", "type": "boolean" }, "state": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } }, "required": [ "id", "mode", "model_id", "base_updated_at", "definition", "changes", "note", "source", "state", "stale", "created_at", "resolved_at" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "SearchSettingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "blocked": { "anyOf": [ { "enum": [ "settings_unreadable" ], "type": "string" }, { "type": "null" } ] }, "eligible_models": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "enabled": { "type": "boolean" }, "models": { "items": { "type": "string" }, "type": "array" }, "modes": { "additionalProperties": { "enum": [ "word", "english_stem", "substring" ], "type": "string" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "revision": { "type": "string" }, "tunable_models": { "items": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label" ], "type": "object" }, "type": "array" }, "kind": { "enum": [ "page", "post", "entry" ], "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "title_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "slug", "name", "kind", "title_field", "fields" ], "type": "object" }, "type": "array" }, "weights": { "additionalProperties": { "additionalProperties": { "maximum": 10, "minimum": 1, "type": "integer" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" } }, "required": [ "enabled", "models", "blocked", "active", "weights", "modes", "eligible_models", "tunable_models", "revision" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SearchSettingsUpdate": { "additionalProperties": false, "properties": { "enabled": { "type": "boolean" }, "expected_revision": { "minLength": 1, "type": "string" }, "models": { "items": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "maxItems": 16, "type": "array" }, "modes": { "additionalProperties": { "enum": [ "word", "english_stem", "substring" ], "type": "string" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "weights": { "additionalProperties": { "additionalProperties": { "maximum": 10, "minimum": 1, "type": "integer" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" } }, "required": [ "enabled", "models", "expected_revision" ], "type": "object" }, "SearchSettingsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "active": { "type": "boolean" }, "blocked": { "anyOf": [ { "enum": [ "settings_unreadable" ], "type": "string" }, { "type": "null" } ] }, "eligible_models": { "items": { "additionalProperties": false, "properties": { "name": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "slug", "name" ], "type": "object" }, "type": "array" }, "enabled": { "type": "boolean" }, "models": { "items": { "type": "string" }, "type": "array" }, "modes": { "additionalProperties": { "enum": [ "word", "english_stem", "substring" ], "type": "string" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "revision": { "type": "string" }, "tunable_models": { "items": { "additionalProperties": false, "properties": { "fields": { "items": { "additionalProperties": false, "properties": { "key": { "type": "string" }, "label": { "type": "string" } }, "required": [ "key", "label" ], "type": "object" }, "type": "array" }, "kind": { "enum": [ "page", "post", "entry" ], "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "title_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "slug", "name", "kind", "title_field", "fields" ], "type": "object" }, "type": "array" }, "weights": { "additionalProperties": { "additionalProperties": { "maximum": 10, "minimum": 1, "type": "integer" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" }, "propertyNames": { "pattern": "^[A-Za-z0-9_-]{1,64}$", "type": "string" }, "type": "object" } }, "required": [ "enabled", "models", "blocked", "active", "weights", "modes", "eligible_models", "tunable_models", "revision" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "SeoSettingsResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "redirects": { "description": "Replaced whole, in order.", "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "match": { "enum": [ "exact", "pattern" ], "type": "string" }, "status": { "enum": [ 301, 302, 307, 308, 410, 451 ], "type": "number" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A site path or an https address for 301, 302, 307 and 308; null for 410 and 451." } }, "required": [ "id", "from", "match", "status", "to" ], "type": "object" }, "type": "array" }, "revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these settings come from; null when none is accepted. A save names it." }, "robots": { "additionalProperties": false, "properties": { "allow_indexing": { "type": "boolean" }, "disallow": { "description": "Site paths, at most 32.", "items": { "type": "string" }, "type": "array" } }, "required": [ "allow_indexing", "disallow" ], "type": "object" }, "seo": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "og_image": { "additionalProperties": false, "description": "Present when `og_image_media_id` resolved, as recorded at save.", "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "url", "width", "height", "alt" ], "type": "object" }, "og_image_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The default social image, from this site’s media library." }, "organization": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "Organization", "Person" ], "type": "string" }, "logo": { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "url", "width", "height", "alt" ], "type": "object" }, "logo_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "same_as": { "description": "Up to eight https profile addresses.", "items": { "type": "string" }, "type": "array" } }, "required": [ "kind", "name", "logo_media_id", "same_as" ], "type": "object" }, { "type": "null" } ] }, "title_template": { "description": "`{title}` and `{site}`; never markup.", "type": "string" }, "verification": { "additionalProperties": false, "description": "Search-engine ownership tokens, written into public pages as meta tags.", "properties": { "bing": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "google": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinterest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "yandex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "google", "bing", "yandex", "pinterest" ], "type": "object" } }, "required": [ "title_template", "description", "og_image_media_id", "organization", "verification" ], "type": "object" }, "sitemap": { "additionalProperties": false, "properties": { "change_frequency": { "enum": [ "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ], "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "enabled", "change_frequency" ], "type": "object" } }, "required": [ "revision", "seo", "sitemap", "robots", "redirects" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SeoSettingsUpdate": { "additionalProperties": false, "properties": { "expected_revision": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The accepted Site Chrome version these settings come from; null when none is accepted. A save names it." }, "redirect_review_digest": { "description": "Required when a pattern rule changes: the `digest` from `reviewRedirects` for exactly these rules.", "type": "string" }, "redirects": { "description": "Replaced whole, in order.", "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "match": { "enum": [ "exact", "pattern" ], "type": "string" }, "status": { "enum": [ 301, 302, 307, 308, 410, 451 ], "type": "number" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A site path or an https address for 301, 302, 307 and 308; null for 410 and 451." } }, "required": [ "id", "from", "match", "status", "to" ], "type": "object" }, "type": "array" }, "robots": { "additionalProperties": false, "properties": { "allow_indexing": { "type": "boolean" }, "disallow": { "description": "Site paths, at most 32.", "items": { "type": "string" }, "type": "array" } }, "required": [ "allow_indexing", "disallow" ], "type": "object" }, "seo": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "og_image_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The default social image, from this site’s media library." }, "organization": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "Organization", "Person" ], "type": "string" }, "logo_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "same_as": { "description": "Up to eight https profile addresses.", "items": { "type": "string" }, "type": "array" } }, "required": [ "kind", "name", "logo_media_id", "same_as" ], "type": "object" }, { "type": "null" } ] }, "title_template": { "description": "`{title}` and `{site}`; never markup.", "type": "string" }, "verification": { "additionalProperties": false, "description": "Search-engine ownership tokens, written into public pages as meta tags.", "properties": { "bing": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "google": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinterest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "yandex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "google", "bing", "yandex", "pinterest" ], "type": "object" } }, "required": [ "title_template", "description", "og_image_media_id", "organization", "verification" ], "type": "object" }, "sitemap": { "additionalProperties": false, "properties": { "change_frequency": { "enum": [ "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ], "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "enabled", "change_frequency" ], "type": "object" } }, "required": [ "expected_revision" ], "type": "object" }, "SeoSettingsUpdateResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "draft": { "description": "Unaccepted Site Chrome changes: none, kept with this change written in, or left for a person to re-apply.", "enum": [ "none", "carried", "needs_rebase" ], "type": "string" }, "redirects": { "description": "Replaced whole, in order.", "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "match": { "enum": [ "exact", "pattern" ], "type": "string" }, "status": { "enum": [ 301, 302, 307, 308, 410, 451 ], "type": "number" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "A site path or an https address for 301, 302, 307 and 308; null for 410 and 451." } }, "required": [ "id", "from", "match", "status", "to" ], "type": "object" }, "type": "array" }, "revision": { "minLength": 1, "type": "string" }, "robots": { "additionalProperties": false, "properties": { "allow_indexing": { "type": "boolean" }, "disallow": { "description": "Site paths, at most 32.", "items": { "type": "string" }, "type": "array" } }, "required": [ "allow_indexing", "disallow" ], "type": "object" }, "seo": { "additionalProperties": false, "properties": { "description": { "type": "string" }, "og_image": { "additionalProperties": false, "description": "Present when `og_image_media_id` resolved, as recorded at save.", "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "url", "width", "height", "alt" ], "type": "object" }, "og_image_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "description": "The default social image, from this site’s media library." }, "organization": { "anyOf": [ { "additionalProperties": false, "properties": { "kind": { "enum": [ "Organization", "Person" ], "type": "string" }, "logo": { "additionalProperties": false, "properties": { "alt": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "height": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] }, "url": { "type": "string" }, "width": { "anyOf": [ { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, { "type": "null" } ] } }, "required": [ "url", "width", "height", "alt" ], "type": "object" }, "logo_media_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "same_as": { "description": "Up to eight https profile addresses.", "items": { "type": "string" }, "type": "array" } }, "required": [ "kind", "name", "logo_media_id", "same_as" ], "type": "object" }, { "type": "null" } ] }, "title_template": { "description": "`{title}` and `{site}`; never markup.", "type": "string" }, "verification": { "additionalProperties": false, "description": "Search-engine ownership tokens, written into public pages as meta tags.", "properties": { "bing": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "google": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pinterest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "yandex": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "google", "bing", "yandex", "pinterest" ], "type": "object" } }, "required": [ "title_template", "description", "og_image_media_id", "organization", "verification" ], "type": "object" }, "sitemap": { "additionalProperties": false, "properties": { "change_frequency": { "enum": [ "always", "hourly", "daily", "weekly", "monthly", "yearly", "never" ], "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "enabled", "change_frequency" ], "type": "object" } }, "required": [ "revision", "seo", "sitemap", "robots", "redirects", "draft" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "SharedDraftDiscard": { "additionalProperties": false, "properties": { "kind": { "enum": [ "content", "page" ], "type": "string" }, "locale": { "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$", "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" } }, "required": [ "locale", "kind" ], "type": "object" }, "SharedDraftDiscardResponse": { "additionalProperties": false, "properties": { "data": { "type": "null" } }, "required": [ "data" ], "type": "object" }, "SharedDraftResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "baseline_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": {}, "expires_at": { "type": "string" }, "kind": { "enum": [ "content", "page" ], "type": "string" }, "locale": { "type": "string" }, "revision": { "maximum": 9007199254740991, "minimum": 1, "type": "integer" }, "target": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "kind", "target", "locale", "baseline_version_id", "revision", "data", "updated_at", "expires_at" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "SharedDraftWrite": { "additionalProperties": false, "properties": { "baseline_version_id": { "anyOf": [ { "maxLength": 128, "minLength": 1, "type": "string" }, { "type": "null" } ] }, "data": { "additionalProperties": {}, "propertyNames": { "type": "string" }, "type": "object" }, "expected_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "kind": { "enum": [ "content", "page" ], "type": "string" }, "locale": { "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$", "type": "string" } }, "required": [ "locale", "kind", "baseline_version_id", "expected_revision", "data" ], "type": "object" }, "SiteContextResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "actor": { "additionalProperties": false, "properties": { "email": { "type": "string" }, "id": { "minLength": 1, "type": "string" } }, "required": [ "id", "email" ], "type": "object" }, "credential": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "model_ids": { "anyOf": [ { "items": { "minLength": 1, "type": "string" }, "type": "array" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "items": { "enum": [ "content:read", "content:write", "content:propose", "pages:write", "media:write", "lifecycle:publish", "content:trash", "content:purge", "workflow:move", "workflow:assign", "settings:write", "schema:propose", "schema:write", "plugins:use", "data:import", "data:export", "roles:write" ], "type": "string" }, "type": "array" } }, "required": [ "id", "name", "scopes", "model_ids" ], "type": "object" }, "site": { "additionalProperties": false, "properties": { "default_lang": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name", "default_lang" ], "type": "object" } }, "required": [ "site", "credential", "actor" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "TransitionResultResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "locale": { "type": "string" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published": { "type": "boolean" }, "published_changed": { "type": "boolean" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "redirect": { "oneOf": [ { "additionalProperties": false, "properties": { "draft": { "enum": [ "none", "carried", "needs_rebase" ], "type": "string" }, "redirects": { "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ], "type": "object" }, "type": "array" }, "status": { "const": "created", "type": "string" } }, "required": [ "status", "redirects", "draft" ], "type": "object" }, { "additionalProperties": false, "properties": { "redirects": { "items": { "additionalProperties": false, "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ], "type": "object" }, "type": "array" }, "status": { "const": "exists", "type": "string" } }, "required": [ "status", "redirects" ], "type": "object" }, { "additionalProperties": false, "properties": { "reason": { "enum": [ "no_previous_address", "address_unchanged", "no_public_address" ], "type": "string" }, "status": { "const": "none", "type": "string" } }, "required": [ "status", "reason" ], "type": "object" }, { "additionalProperties": false, "properties": { "from": { "type": "string" }, "message": { "type": "string" }, "reason": { "enum": [ "redirect_loop", "redirect_collision", "redirect_limit", "redirect_invalid", "redirect_failed" ], "type": "string" }, "status": { "const": "refused", "type": "string" }, "to": { "type": "string" } }, "required": [ "status", "reason", "message", "from", "to" ], "type": "object" } ] }, "replayed": { "type": "boolean" }, "revision": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "to": { "type": "string" } }, "required": [ "instance_id", "primary_instance_id", "from", "to", "published", "published_changed", "published_version_id", "revision", "policy_results" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "TrashCommand": { "additionalProperties": false, "properties": { "scope": { "description": "`entry` moves every language. `language` moves this one non-owner language alone.", "enum": [ "entry", "language" ], "type": "string" } }, "required": [ "scope" ], "type": "object" }, "TrashListResponse": { "additionalProperties": false, "properties": { "data": { "items": { "additionalProperties": false, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "type": "string" }, "deleted_by_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lang": { "type": "string" }, "model_id": { "minLength": 1, "type": "string" }, "model_slug": { "type": "string" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purge_after": { "type": "string" }, "scope": { "description": "The whole entry, or one language moved to Trash on its own.", "enum": [ "entry", "language" ], "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "translation_group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "instance_id", "primary_instance_id", "translation_group_id", "model_id", "model_slug", "lang", "label", "slug", "current_version_id", "published_version_id", "scope", "deleted_at", "deleted_by_id", "purge_after" ], "type": "object" }, "type": "array" }, "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "next" ], "type": "object" }, "TrashPreflightResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "comments": { "description": "Visitor comments that deleting this item permanently also deletes.", "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "conflicts": { "description": "Restore is refused while any remain.", "items": { "additionalProperties": false, "properties": { "held_by": { "minLength": 1, "type": "string" }, "kind": { "const": "address_taken", "type": "string" }, "lang": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "kind", "lang", "slug", "held_by" ], "type": "object" }, "type": "array" }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_by_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "model_slug": { "type": "string" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "purge_after": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "references": { "description": "Links that will not work once restored. Not blocking.", "items": { "additionalProperties": false, "properties": { "field_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instance_id": { "minLength": 1, "type": "string" }, "kind": { "enum": [ "linked_in_trash", "link_removed" ], "type": "string" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "kind", "instance_id", "slug", "field_key" ], "type": "object" }, "type": "array" }, "scope": { "enum": [ "entry", "language" ], "type": "string" } }, "required": [ "instance_id", "primary_instance_id", "scope", "model_slug", "languages", "deleted_at", "deleted_by_id", "purge_after", "conflicts", "references", "comments" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "TrashResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "deleted_at": { "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "purge_after": { "type": "string" }, "scope": { "enum": [ "entry", "language" ], "type": "string" } }, "required": [ "instance_id", "primary_instance_id", "scope", "languages", "deleted_at", "purge_after", "policy_results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "TrashRestoreResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "instance_id": { "minLength": 1, "type": "string" }, "languages": { "items": { "type": "string" }, "type": "array" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "scope": { "enum": [ "entry", "language" ], "type": "string" } }, "required": [ "instance_id", "primary_instance_id", "scope", "languages", "policy_results" ], "type": "object" }, "replayed": { "type": "boolean" } }, "required": [ "data" ], "type": "object" }, "UnpublishCommand": { "additionalProperties": false, "properties": { "acknowledged_dependents": { "items": { "minLength": 1, "type": "string" }, "type": "array" }, "expected_published_version_id": { "minLength": 1, "type": "string" }, "expected_workflow_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "locale": { "description": "Move this one language only. Absent moves every language of the entry.", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" }, "note": { "maxLength": 2000, "type": "string" }, "to": { "minLength": 1, "type": "string" } }, "required": [ "to", "expected_workflow_revision", "expected_published_version_id" ], "type": "object" }, "VersionPageResponse": { "additionalProperties": {}, "properties": { "current_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "items": { "additionalProperties": {}, "properties": { "author_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "version_number": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "version_number", "label", "author_email", "created_at" ], "type": "object" }, "type": "array" }, "limit": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "data", "next_cursor", "limit", "total", "primary_instance_id", "current_version_id", "published_version_id" ], "type": "object" }, "VersionResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "author_email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "data": {}, "id": { "minLength": 1, "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "version_number": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "version_number", "label", "author_email", "created_at", "data" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "VersionRestore": { "additionalProperties": false, "properties": { "expected_current_version_id": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ] }, "locale": { "description": "Restore this language only. Its fields, its relation lists and its address come from the version; shared fields, shared relations, media and every other language stay as they are. Absent restores every language.", "pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$", "type": "string" } }, "required": [ "expected_current_version_id" ], "type": "object" }, "VersionRestoreResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": false, "properties": { "current_version_id": { "minLength": 1, "type": "string" }, "instance_id": { "minLength": 1, "type": "string" }, "policy_results": { "description": "Plugin content policies that warned, did not answer while set to warn, or transformed the stored content. A refusal is an error instead.", "items": { "additionalProperties": false, "properties": { "failure": { "anyOf": [ { "enum": [ "plugin_timeout", "plugin_unreachable", "plugin_response_invalid", "plugin_refused", "plugin_unavailable", "idempotency_key_reused", "invocation_in_progress", "input_too_large", "audit_unavailable" ], "type": "string" }, { "type": "null" } ], "description": "Why an `unavailable` policy did not answer; null otherwise." }, "fields": { "description": "Field keys the message is about; for `transformed`, the keys the policy changed (`seo` for search settings).", "items": { "type": "string" }, "type": "array" }, "installation_id": { "type": "string" }, "locale": { "type": "string" }, "message": { "type": "string" }, "outcome": { "enum": [ "warning", "unavailable", "transformed" ], "type": "string" }, "plugin_name": { "type": "string" }, "policy_id": { "type": "string" }, "policy_label": { "type": "string" } }, "required": [ "installation_id", "plugin_name", "policy_id", "policy_label", "locale", "outcome", "message", "fields", "failure" ], "type": "object" }, "type": "array" }, "primary_instance_id": { "minLength": 1, "type": "string" }, "published_version_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "restored_from": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" }, "version": { "additionalProperties": false, "properties": { "id": { "minLength": 1, "type": "string" }, "version_number": { "maximum": 9007199254740991, "minimum": -9007199254740991, "type": "integer" } }, "required": [ "id", "version_number" ], "type": "object" }, "warnings": { "items": { "type": "string" }, "type": "array" } }, "required": [ "instance_id", "primary_instance_id", "version", "current_version_id", "published_version_id", "restored_from", "warnings", "policy_results" ], "type": "object" } }, "required": [ "data" ], "type": "object" }, "WordPressMappingSave": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 9007199254740991, "minimum": 0, "type": "integer" }, "mapping": { "additionalProperties": {}, "description": "The WordPress choices, as `getWordPressReview` reads them under `mapping`: language, content, publication, pages, metadata, and `types` and `taxonomies` (WordPress name -> `{ model, create, fields }`, where `fields` maps a source field id from the review to a field key). An absent type or taxonomy is left out.", "properties": {}, "type": "object" } }, "required": [ "expected_revision", "mapping" ], "type": "object" }, "WordPressReviewResponse": { "additionalProperties": false, "properties": { "data": { "additionalProperties": {}, "properties": { "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Read on with this `cursor`; `null` after the last items." }, "status": { "type": "string" }, "totals": { "additionalProperties": {}, "description": "How many items each paged list holds in all, at the same place the list sits: a number per list, an object of numbers for a record of lists.", "propertyNames": { "type": "string" }, "type": "object" } }, "required": [ "status", "totals", "next_cursor" ], "type": "object" } }, "required": [ "data" ], "type": "object" } }, "securitySchemes": { "managementCredential": { "description": "A credential from Settings → API, `dwm_` followed by 43 base64url characters.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Site-scoped management of content, pages and media over the CMS lifecycle services. Authority is the credential scopes intersected with its creator’s current permissions.", "title": "Dee Wan CMS management API", "version": "1.12.0" }, "openapi": "3.1.0", "paths": { "/comments": { "get": { "operationId": "listComments", "parameters": [ { "in": "query", "name": "state", "required": false, "schema": { "description": "Default `pending`.", "enum": [ "pending", "approved", "spam", "refused", "all" ], "type": "string" } }, { "in": "query", "name": "model", "required": false, "schema": { "description": "A model slug.", "type": "string" } }, { "in": "query", "name": "entry", "required": false, "schema": { "description": "An entry's translation group id.", "type": "string" } }, { "in": "query", "name": "lang", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Visitor comments, newest first, 50 per page, filtered by state, model, entry and language. Private email is not listed.", "x-audited": false, "x-destructive": false, "x-scope": "lifecycle:publish" } }, "/comments/moderate": { "post": { "operationId": "moderateComments", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentModerate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentModerateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Approve, refuse or mark as spam up to 25 comments, each only if still in the state it was read in. A comment moved since answers `conflict`; one imported without consent answers `consent_missing`.", "x-audited": true, "x-destructive": false, "x-scope": "lifecycle:publish" } }, "/comments/publish-imported": { "post": { "operationId": "publishImportedComment", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPublishImported" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentPublishImportedResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Show ONE comment an import carried without consent to visitors. Consent stays false; the decision is recorded.", "x-audited": true, "x-destructive": false, "x-scope": "lifecycle:publish" } }, "/comments/remove": { "post": { "operationId": "deleteComments", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentDelete" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentDeleteResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete up to 25 comments, their replies and reactions, each only if still in the state it was read in. Needs moderation (`lifecycle:publish`) and delete on each comment’s model. Cannot be undone.", "x-audited": true, "x-destructive": true, "x-scope": "content:purge" } }, "/comments/settings": { "get": { "operationId": "getCommentSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentSettingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Which models take visitor comments on their public entries.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateCommentSettings", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentSettingsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Open or close one model's public entries to visitor comments. Closing hides its comments from visitors; nothing is deleted.", "x-audited": true, "x-destructive": false, "x-scope": "settings:write" } }, "/comments/{id}": { "get": { "operationId": "getComment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One comment with its private email, its parent and its entry.", "x-audited": false, "x-destructive": false, "x-scope": "lifecycle:publish" } }, "/entries": { "get": { "operationId": "listEntries", "parameters": [ { "in": "query", "name": "model_id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "published", "required": false, "schema": { "enum": [ "true", "false" ], "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "1 to 50, default 20.", "pattern": "^\\d{1,2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Translation-group primaries of one model, by id, in pages.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "createEntry", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveResultResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a draft entry through the lifecycle service.", "x-audited": true, "x-destructive": false, "x-scope": "content:write" } }, "/entries/relate": { "post": { "operationId": "relateEntries", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelateCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Add or remove up to 10 linked entries in one many-to-many field of many entries, each its own draft save. Never publishes.", "x-audited": true, "x-destructive": true, "x-scope": "content:write" } }, "/entries/{id}": { "get": { "operationId": "getEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One entry: pointers, workflow state, revision and the publish or unpublish moves open to this credential.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "put": { "operationId": "updateEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntryUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveResultResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Save a new draft version of an entry. Optimistic: names the version it replaces.", "x-audited": true, "x-destructive": true, "x-scope": "content:write" } }, "/entries/{id}/assignees": { "get": { "operationId": "listEntryAssignees", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssigneeListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The site members who could take this entry on from its current state.", "x-audited": false, "x-destructive": false, "x-scope": "workflow:assign" } }, "/entries/{id}/assignment": { "put": { "operationId": "assignEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignmentResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Name who moves this entry on next, with an optional due date. Null clears it.", "x-audited": true, "x-destructive": true, "x-scope": "workflow:assign" } }, "/entries/{id}/dependents": { "get": { "operationId": "getEntryDependents", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DependentsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Content that references this entry. Unpublish acknowledges exactly `ids`.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/entries/{id}/editing": { "get": { "operationId": "getEditing", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "locale", "required": true, "schema": { "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$", "type": "string" } }, { "in": "query", "name": "kind", "required": true, "schema": { "enum": [ "content", "page" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditingStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Who holds the editing lease of this entry and language now, and its shared draft: the unsaved work the holder autosaves, projected to the fields and languages the credential may read.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/entries/{id}/editing/draft": { "put": { "operationId": "writeSharedDraft", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDraftWrite" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDraftResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Write the shared draft of this entry and language over the revision you read (409 `draft_conflict` when it moved). Refused 423 `locked` while another person holds the editing lease. Never a version: save the entry to keep it.", "x-audited": false, "x-destructive": true, "x-scope": "content:write" } }, "/entries/{id}/editing/draft/discard": { "post": { "operationId": "discardSharedDraft", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDraftDiscard" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedDraftDiscardResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Discard the shared draft of this entry and language. Refused 423 `locked` while another person holds the editing lease.", "x-audited": false, "x-destructive": true, "x-scope": "content:write" } }, "/entries/{id}/editing/takeover": { "post": { "operationId": "takeOverEditing", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditingTakeOver" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditingTakeOverResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "End the editing lease another person holds on this entry and language, at once. Their next save is refused `lock_lost` and their unsaved work is kept as their recovery draft. Nobody holds the lease afterwards.", "x-audited": false, "x-destructive": false, "x-scope": "content:write" } }, "/entries/{id}/locales": { "post": { "operationId": "addEntryLocale", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleAdd" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocaleAddResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Start a translation: add one site language to the entry, empty until a save writes it.", "x-audited": true, "x-destructive": false, "x-scope": "content:write" } }, "/entries/{id}/proposals": { "get": { "operationId": "listEntryProposals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Proposals made for this entry, newest first, with their review state.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "createEntryProposal", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProposalResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Propose field changes for an editor to review. Nothing changes until a person applies them.", "x-audited": true, "x-destructive": false, "x-scope": "content:propose" } }, "/entries/{id}/publish": { "post": { "operationId": "publishEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionResultResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Take a workflow transition that publishes the pinned current version. No second confirmation.", "x-audited": true, "x-destructive": true, "x-scope": "lifecycle:publish" } }, "/entries/{id}/related-from": { "get": { "operationId": "getRelatedFrom", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedFromResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The entries whose relation fields point at this one, by source model and field, with the version each change must name.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "put": { "operationId": "changeRelatedFrom", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedFromChange" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelatedFromChangeResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Point one source entry’s relation field at this entry, or stop it pointing here: the source’s own draft save, pinned to its version. Never publishes.", "x-audited": true, "x-destructive": true, "x-scope": "content:write" } }, "/entries/{id}/transition": { "post": { "operationId": "moveEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoveCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionResultResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Take a workflow step that neither publishes nor unpublishes, such as Submit for review.", "x-audited": true, "x-destructive": true, "x-scope": "workflow:move" } }, "/entries/{id}/trash": { "get": { "operationId": "getTrashEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashPreflightResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "What restoring this Trash item would run into: address conflicts block it, broken links do not.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "trashEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Move an entry, or one non-owner language, to Trash. Live content is refused until unpublished.", "x-audited": true, "x-destructive": true, "x-scope": "content:trash" } }, "/entries/{id}/trash/purge": { "post": { "operationId": "purgeEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurgeResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete a Trash item permanently, with its history and visitor comments. Cannot be undone.", "x-audited": true, "x-destructive": true, "x-scope": "content:purge" } }, "/entries/{id}/trash/restore": { "post": { "operationId": "restoreTrashedEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashRestoreResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Bring a Trash item back as a draft. Refused while another item uses its address.", "x-audited": true, "x-destructive": false, "x-scope": "content:trash" } }, "/entries/{id}/unpublish": { "post": { "operationId": "unpublishEntry", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnpublishCommand" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionResultResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Take a workflow transition that unpublishes the pinned published version. No second confirmation.", "x-audited": true, "x-destructive": true, "x-scope": "lifecycle:publish" } }, "/entries/{id}/versions": { "get": { "operationId": "listEntryVersions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionPageResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Version history, newest first, in cursor pages.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/entries/{id}/versions/{versionId}": { "get": { "operationId": "getEntryVersion", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One version with its full snapshot.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/entries/{id}/versions/{versionId}/restore": { "post": { "operationId": "restoreEntryVersion", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "versionId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionRestore" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionRestoreResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Make an old version the current draft again, as a new version. What is live does not change.", "x-audited": true, "x-destructive": true, "x-scope": "content:write" } }, "/exports": { "post": { "operationId": "createExport", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCreatedResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Ask for an export. Then build it with `advanceExport` until `more` is false, and read it with `readExportChunk`.", "x-audited": true, "x-destructive": false, "x-scope": "data:export" } }, "/exports/{id}": { "get": { "operationId": "getExportJob", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "An export: its status, the pages built so far and the whole file once it is finished.", "x-audited": false, "x-destructive": false, "x-scope": "data:export" } }, "/exports/{id}/advance": { "post": { "operationId": "advanceExport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Build and keep the next page of the export, or, after its last page, finish it into one file with its size and SHA-256. Pages are never replaced. Call again while `more` is true. A finished export is answered as it stands.", "x-audited": true, "x-destructive": false, "x-scope": "data:export" } }, "/exports/{id}/artifact": { "get": { "operationId": "readExportChunk", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "description": "Byte offset, default 0.", "pattern": "^\\d{1,12}$", "type": "string" } }, { "in": "query", "name": "length", "required": false, "schema": { "description": "Bytes to read, 1 to 4194304, default 4194304.", "pattern": "^\\d{1,8}$", "type": "string" } }, { "in": "query", "name": "page", "required": false, "schema": { "description": "Read this page, numbered from 0, instead of the whole export. A page is kept until the whole export is finished.", "pattern": "^\\d{1,6}$", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK.", "headers": { "X-Artifact-Content-Type": { "description": "The type of the whole file.", "schema": { "type": "string" } }, "X-Artifact-Length": { "description": "How many bytes this answer carries.", "schema": { "type": "string" } }, "X-Artifact-Next-Offset": { "description": "Where the next read of this file starts. Absent at its end.", "schema": { "type": "string" } }, "X-Artifact-Next-Page": { "description": "The page to read after this one ends. Absent before its end, and when no later page is built yet.", "schema": { "type": "string" } }, "X-Artifact-Offset": { "description": "Where these bytes start.", "schema": { "type": "string" } }, "X-Artifact-Page": { "description": "The page these bytes belong to. Absent when reading the whole export.", "schema": { "type": "string" } }, "X-Artifact-Sha256": { "description": "SHA-256 of the whole file.", "schema": { "type": "string" } }, "X-Artifact-Total": { "description": "The size of the whole file.", "schema": { "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "A byte range of the finished export, or with `page` of one kept page, at most 4194304 bytes. An unfinished export without `page` is 409 `export_not_final`; a page removed once the export finished is 409 `export_page_gone`; a stored file that is not the recorded one is 409 `export_artifact_changed`.", "x-audited": false, "x-destructive": false, "x-scope": "data:export" } }, "/imports": { "get": { "operationId": "listImportJobs", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "description": "1 to 100, default 20.", "pattern": "^\\d{1,3}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportJobListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Import jobs of this site, most recently changed first. One job at a time holds the site until it finishes, is cancelled or is undone.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "post": { "operationId": "createImport", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportCreatedResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Start an import job, then upload its file in parts with `uploadImportPart`.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/sources": { "get": { "operationId": "listImportSources", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSourceListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The reusable import sources of this site. A later import from the same source skips what it already imported and never changes it; only a menu still exactly as the last import wrote it gains the items that now map.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "post": { "operationId": "createImportSource", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSourceCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSourceResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a reusable import source ahead of a job.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}": { "get": { "operationId": "getImportJob", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportJobResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "An import job: its stage, findings, what it waits for and the operations open now.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/advance": { "post": { "operationId": "advanceImport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "recheck", "required": false, "schema": { "const": "true", "description": "Check a finished check again, as the admin \"Check again\" does. Ignored unless the check has finished.", "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Run the one next bounded step the admin import would run: finish native archive verification, prepare, read the file, plan, produce, check or import. Stops at a decision a person must make. Call again while `more` is true.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/archive/complete": { "post": { "operationId": "completeImportUpload", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportComplete" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Assemble the uploaded parts and verify the stored file. Native transfer verification continues in bounded byte ranges: call advanceImport while more is true, or repeat completion with a fresh idempotency key until outcome.more is false. client_sha256_matches is set only after sealing.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/archive/parts/{part}": { "put": { "operationId": "uploadImportPart", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "part", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/octet-stream": { "schema": { "$ref": "#/components/schemas/ImportArchivePart" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Upload one part of the import file, numbered from 1. Every part but the last is exactly 5242880 bytes. Sending the same bytes again is answered as before; different bytes for a part already received are refused with 409 `import_part_conflict`.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/artifacts/{name}": { "get": { "operationId": "readImportArtifact", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "name", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "offset", "required": false, "schema": { "description": "Byte offset, default 0.", "pattern": "^\\d{1,12}$", "type": "string" } }, { "in": "query", "name": "length", "required": false, "schema": { "description": "Bytes to read, 1 to 4194304, default 4194304.", "pattern": "^\\d{1,8}$", "type": "string" } } ], "responses": { "200": { "content": { "application/octet-stream": { "schema": { "format": "binary", "type": "string" } } }, "description": "OK.", "headers": { "X-Artifact-Content-Type": { "description": "The type of the whole file.", "schema": { "type": "string" } }, "X-Artifact-Length": { "description": "How many bytes this answer carries.", "schema": { "type": "string" } }, "X-Artifact-Next-Offset": { "description": "Where the next read of this file starts. Absent at its end.", "schema": { "type": "string" } }, "X-Artifact-Offset": { "description": "Where these bytes start.", "schema": { "type": "string" } }, "X-Artifact-Sha256": { "description": "SHA-256 of the whole file.", "schema": { "type": "string" } }, "X-Artifact-Total": { "description": "The size of the whole file.", "schema": { "type": "string" } } } }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "A byte range of a finished import’s evidence, at most 4194304 bytes: `receipt` (JSON), `problems` (CSV), `entries` and `media` (JSON lines), `partition` (Strapi source selection, JSON), `plugin_data` (WordPress data the import does not read in, JSON; available from review on). The headers give the whole file’s size, type and SHA-256 and where the next read starts.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/assignments": { "get": { "operationId": "getHistoryAssignments", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Source rows per page: native transfer 1 to 100, default 50; JSON and WordPress 1 to 500, default 200.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque next_cursor returned by the previous review page. Keep it unchanged.", "maxLength": 1024, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryAssignmentsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Carried assignments and suggested members. Native transfers return at most 100 source rows, legacy JSON at most 500. Continue with the opaque next_cursor.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "put": { "operationId": "setHistoryAssignment", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoryAssignmentSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Keep, replace or clear one carried assignment before the import runs.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/cancel": { "post": { "operationId": "cancelImport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Cancel the import. Content it already imported stays and can be undone. A cleanup that has not settled answers with decision `cancel_pending`; cancel again.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/findings": { "get": { "operationId": "getImportFindings", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Findings to read, 1 to 500, default 100.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Where to go on: the `next_cursor` of the page before.", "pattern": "^[0-2]\\.\\d{1,18}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportFindingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "What the import found, worst first, at most 500 a read, with counts and the decision the job waits for. Read on with `next_cursor`.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/mapping": { "get": { "operationId": "getImportMapping", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "List items to read, 1 to 500, default 200.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Where to go on: the `next_cursor` of the page before.", "pattern": "^\\d{1,9}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "A Strapi import: the types found (a single type has `single: true` and becomes a single-entry model), the component definitions its components and dynamic zones become (`components`, each with its fields and the types that use it), the saved mapping and its review. `review.unresolved` lists what still needs a choice. `types`, `components`, `normalized.skipped_fields`, each list of `normalized.group_keys` and `review.unresolved` hold at most 500 items a read; read on with `next_cursor`. `mapping` comes whole.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "put": { "operationId": "setImportMapping", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Save the Strapi mapping against the plan revision you read. A stale revision is refused; a saved mapping needs a new check.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/pause": { "post": { "operationId": "pauseImport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Stop claiming new import work. Work already running finishes.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/principals": { "get": { "operationId": "getImportPrincipals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Source rows per page: native transfer 1 to 100, default 50; JSON and WordPress 1 to 500, default 200.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque next_cursor returned by the previous review page. Keep it unchanged.", "maxLength": 1024, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPrincipalsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Source principals, their credits, saved choices, and exact-email suggestions. Native transfers page at most 100 principals with an opaque next_cursor and include the active-member choice list. Legacy imports page at most 500 principals and members. Mapping creates or changes no account.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "put": { "operationId": "setImportPrincipal", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportPrincipalSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Map one source principal to an active member of this site, or leave it unmapped with `user_id: null`. The source label is kept either way. The check refuses a mapping to someone who is no longer an active member.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/principals/accept-suggestions": { "post": { "operationId": "acceptImportPrincipalSuggestions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Source rows per page: native transfer 1 to 100, default 50; JSON and WordPress 1 to 500, default 200.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Opaque next_cursor returned by the previous review page. Keep it unchanged.", "maxLength": 1024, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Accept exact-email suggestions for undecided principals on the requested native-transfer page. Read that page first and pass its cursor and limit; continue with the next_cursor from that read. Legacy JSON and WordPress apply all suggestions. Existing choices stay.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/resume": { "post": { "operationId": "resumeImport", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Resume a paused import by running its next import step. A job that is not paused is answered as it stands.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/undo": { "post": { "operationId": "advanceImportUndo", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Remove one batch of what this import created. Call again while the step outcome says `more`. Each removal needs your permission for it now; refused ones stop the undo with decision `undo_refused`.", "x-audited": true, "x-destructive": true, "x-scope": "data:import" } }, "/imports/{id}/undo/retry": { "post": { "operationId": "retryImportUndo", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Return refused undo work to the queue once the reason is fixed. Then call `advanceImportUndo`.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/imports/{id}/wordpress": { "get": { "operationId": "getWordPressReview", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "List items to read, 1 to 500, default 200.", "pattern": "^\\d{1,3}$", "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "description": "Where to go on: the `next_cursor` of the page before.", "pattern": "^\\d{1,9}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressReviewResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "A WordPress import: what the export holds, the saved choices and what each post, page and custom item would lose; `types` and `taxonomies` list each custom post type and taxonomy with its fields, the field a new model gives each and the fields of `models` that can hold it. `posts`, `pages` and `entries` hold at most 500 items a read; read on with `next_cursor`.", "x-audited": false, "x-destructive": false, "x-scope": "data:import" }, "put": { "operationId": "setWordPressMapping", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WordPressMappingSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportStateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Save the WordPress choices against the plan revision you read. A stale revision is refused.", "x-audited": true, "x-destructive": false, "x-scope": "data:import" } }, "/languages": { "get": { "operationId": "listLanguages", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The languages of the site. `is_default` marks the one new entries start in.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/media": { "get": { "operationId": "listMedia", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The media library of the site.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "uploadMedia", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MediaUpload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaReusedResponse" } } }, "description": "The site already holds these bytes and `on_duplicate` is `use_existing`: the existing file, with `reused: true`." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaResponse" } } }, "description": "Created." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaDuplicate" } } }, "description": "The site already holds these bytes and `on_duplicate` is `ask`. Nothing was stored or recorded." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Upload one file of a kind and format the site accepts: an image, a document, audio, video, or another file as a download. An exact retry under the same key returns the recorded result.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/folders": { "get": { "operationId": "listMediaFolders", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderTreeResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The library folder tree with each folder's own and subtree file counts, and how many files are Unfiled. Folders are admin organization: no public read serves them.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "createMediaFolder", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a library folder at the top or under another. At most 5 levels and 500 folders per site.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/folders/{id}": { "put": { "operationId": "updateMediaFolder", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Rename a folder, move it under another folder or to the top, or both, against the revision you read. A stale revision is refused with 409 `media_folder_changed`.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/folders/{id}/remove": { "post": { "operationId": "deleteMediaFolder", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderDelete" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFolderDeleteResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete a folder and every folder below it. No file is deleted: each file in them becomes Unfiled. Refused with 409 `media_folder_changed` unless the revision and both confirmed counts still hold.", "x-audited": true, "x-destructive": true, "x-scope": "media:write" } }, "/media/move": { "post": { "operationId": "moveMediaToFolder", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaMove" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaMoveResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Put up to 200 files in one folder, or in Unfiled. Stored files and their addresses never change.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/sources": { "get": { "operationId": "listMediaSources", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourceListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The external media sources active plugins offer this site: libraries to browse and copy files from.", "x-audited": false, "x-destructive": false, "x-scope": "media:write" } }, "/media/sources/{installationId}/{sourceId}/import": { "post": { "operationId": "importMediaSourceItem", "parameters": [ { "in": "path", "name": "installationId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "sourceId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourceImport" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourceReusedResponse" } } }, "description": "The site already holds these bytes, or a link to this item, and `on_duplicate` is `use_existing`: the existing file, unchanged." }, "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourceImportResponse" } } }, "description": "Created." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourceDuplicate" } } }, "description": "The site already holds these bytes, or a link to this item, and `on_duplicate` is `ask`. Nothing was stored or recorded." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Add one item of a media source to the library, by `mode`. `copy`: core fetches the file from the plugin and checks it like any upload; the new file keeps the source’s credit and never depends on the source again. `reference`: core keeps the provider’s delivery URL and the item’s identity and no bytes. An exact retry under the same key returns the recorded result.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/sources/{installationId}/{sourceId}/items": { "get": { "operationId": "browseMediaSource", "parameters": [ { "in": "path", "name": "installationId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "sourceId", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "q", "required": false, "schema": { "description": "Search text. Absent: the source’s own first page.", "maxLength": 200, "type": "string" } }, { "in": "query", "name": "cursor", "required": false, "schema": { "maxLength": 512, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaSourcePageResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One page of a media source, at most 24 items, searched by `q`. The plugin answers it now; nothing is stored.", "x-audited": false, "x-destructive": false, "x-scope": "media:write" } }, "/media/{id}": { "get": { "operationId": "getMedia", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaItemResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One media item, in the same shape as the media library list.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "put": { "operationId": "updateMedia", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change what the media library edits on a file: alt text per language, the default focal point of an image, loading and fetch priority. The file itself never changes.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/{id}/originals": { "get": { "operationId": "listMediaOriginals", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaOriginalListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Read the current originals by language for one asset. Private file URLs are null.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/media/{id}/originals/{lang}": { "delete": { "operationId": "removeMediaOriginal", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "lang", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaOriginalRemoval" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaOriginalRemovalResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Remove the reviewed language override. Existing published pins keep their original bytes.", "x-audited": true, "x-destructive": true, "x-scope": "media:write" }, "put": { "operationId": "replaceMediaOriginal", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "lang", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MediaOriginalReplacement" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaOriginalReplacementResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create or replace a language original, keeping the asset identity. Names the reviewed current object; published pins keep prior bytes.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/{id}/remove": { "post": { "operationId": "deleteMedia", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaDeleteResponse" } } }, "description": "OK." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaInUse" } } }, "description": "Something still references the file, or its usage could not be read. Nothing was deleted." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete a media item that nothing references. While anything does, refused with 409 `media_in_use` and the same usage `getMediaUsage` answers.", "x-audited": true, "x-destructive": true, "x-scope": "media:write" } }, "/media/{id}/replace": { "post": { "operationId": "replaceMedia", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/MediaReplacement" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaReplacementResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Replace a library file with the same kind of file, keeping its id, references and metadata. The delivery URL may change. Pinned published versions keep their previous bytes. Exact retries return the recorded result.", "x-audited": true, "x-destructive": false, "x-scope": "media:write" } }, "/media/{id}/usage": { "get": { "operationId": "getMediaUsage", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaUsageResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Where a media item is used: the entries this credential may read, and a count of the ones it may not. The same answer a delete refusal carries.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/menus": { "get": { "operationId": "listMenus", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The site’s menus from the accepted Site Chrome, with where each appears.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" } }, "/menus/{key}": { "get": { "operationId": "getMenu", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One menu, the language version each site language serves, and the languages each item shows in today.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "saveMenu", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuSaveResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create or replace one menu as a new accepted Site Chrome version. Pinned to the revision read; unaccepted Site Chrome changes are kept.", "x-audited": true, "x-destructive": true, "x-scope": "settings:write" } }, "/menus/{key}/languages": { "post": { "operationId": "addMenuLanguage", "parameters": [ { "in": "path", "name": "key", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuLanguageAdd" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MenuLanguageAddResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Add one language version to a menu, blank or copied from another language with new item ids, as a new accepted Site Chrome version.", "x-audited": true, "x-destructive": false, "x-scope": "settings:write" } }, "/models": { "get": { "operationId": "listModels", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Content models this credential may read, with their fields.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "createModel", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelCreateResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a model with its fields, checked and applied as the Content Builder applies it.", "x-audited": true, "x-destructive": false, "x-scope": "schema:write" } }, "/models/proposals": { "get": { "operationId": "listModelProposals", "parameters": [ { "in": "query", "name": "state", "required": false, "schema": { "enum": [ "open", "applied", "dismissed" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaProposalListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Model changes proposed on this site, newest first, with their review state.", "x-audited": false, "x-destructive": false, "x-scope": "schema:propose" }, "post": { "operationId": "proposeModelChange", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaProposalCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaProposalResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Propose a new model or a changed model definition for a person to review in the Content Builder. Nothing changes until they apply it.", "x-audited": true, "x-destructive": false, "x-scope": "schema:propose" } }, "/models/proposals/{id}": { "get": { "operationId": "getModelProposal", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaProposalReadResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One proposed model change, its review state and whether it is out of date.", "x-audited": false, "x-destructive": false, "x-scope": "schema:propose" } }, "/models/{id}": { "get": { "operationId": "getModel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDetailResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One model’s complete definition with field ids, with its revision: where a proposal or a direct change starts from.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "put": { "operationId": "updateModel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change a model’s name, slug, description, settings or translation storage, keeping its fields. Pinned to the revision read; a change unsafe for existing content is refused with what blocks it.", "x-audited": true, "x-destructive": true, "x-scope": "schema:write" } }, "/models/{id}/definition": { "put": { "operationId": "applyModelDefinition", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDefinitionApply" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDefinitionApplyResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Replace a model’s complete definition: fields added, changed, reordered or removed. Pinned to the revision read; a change unsafe for existing content is refused with what blocks it.", "x-audited": true, "x-destructive": true, "x-scope": "schema:write" } }, "/models/{id}/folder": { "put": { "operationId": "setModelFolder", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelFolderSet" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelFolderSetResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Put a model in a content navigation folder, or take it out. Display only: it does not change the model revision, so no `expected_revision` is needed.", "x-audited": true, "x-destructive": false, "x-scope": "schema:write" } }, "/models/{id}/remove": { "post": { "operationId": "deleteModel", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDelete" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModelDeleteResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete a model that holds no content, pinned to the revision read. Grants and token scopes naming it are removed after.", "x-audited": true, "x-destructive": true, "x-scope": "schema:write" } }, "/pages/{id}": { "get": { "operationId": "getPage", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "locale", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "A composed page document, its facts digest and current version, as the page editor reads it.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/pages/{id}/save": { "post": { "operationId": "savePage", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageSave" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageSaveResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The page editor direct save: final ordered sections, optional title and facts.", "x-audited": true, "x-destructive": true, "x-scope": "pages:write" } }, "/pages/{id}/translations": { "post": { "operationId": "startPageTranslation", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTranslationStart" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PageTranslationStartResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Start one language of a page, including a site language the page does not have yet: blank, or a copy of another language. Only that language is written.", "x-audited": true, "x-destructive": false, "x-scope": "pages:write" } }, "/plugins": { "get": { "operationId": "listPlugins", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Installed plugins and what each can open now: management views and entry actions. A disabled plugin opens nothing.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/content-actions": { "get": { "operationId": "listPluginContentActions", "parameters": [ { "in": "query", "name": "instance_id", "required": false, "schema": { "description": "Only the actions this entry offers.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginContentActionListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The entry actions active plugins declare on models this credential reads, with the models each may open on and its MCP tool.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/manage-views": { "get": { "operationId": "listPluginManageViews", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginManageViewListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The management views active plugins declare that this credential could open now, each with its MCP tool.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/operations": { "get": { "operationId": "listPluginOperations", "parameters": [ { "in": "query", "name": "instance_id", "required": false, "schema": { "description": "Only the entry operations this entry offers.", "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginOperationListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The interactive operations active plugins declare that this credential may run now: site operations, and entry operations with the models each may run on, each with its MCP tool. Automation operations are never listed.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/{id}/content-actions/{action}/entries/{instanceId}/launch": { "post": { "operationId": "launchPluginContentAction", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "action", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "instanceId", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginLaunchResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a one-time, short-lived link that opens one plugin action on one entry as the credential’s person. Only the link is created; nothing runs in the plugin.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/{id}/manage-views/{view}/launch": { "post": { "operationId": "launchPluginManageView", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "view", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginLaunchResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a one-time, short-lived link that opens one plugin management view as the credential’s person. Only the link is created; nothing runs in the plugin.", "x-audited": false, "x-destructive": false, "x-scope": "plugins:use" } }, "/plugins/{id}/operations/{operation}/invoke": { "post": { "operationId": "invokePluginOperation", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "path", "name": "operation", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginOperationInvoke" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PluginOperationRunResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Run one interactive plugin operation as the credential’s person and return its result. The plugin runs it now. An automation operation is refused as unavailable. An exact retry with the same key returns the first result.", "x-audited": true, "x-destructive": false, "x-scope": "plugins:use" } }, "/rich-blocks": { "get": { "operationId": "listRichBlockDefinitions", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RichBlockSourceListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The rich text block types installed plugins declare: fields, rules, sample values, render tree and migrations. Only an active plugin’s blocks can be added to content; a block of a disabled or removed plugin stays stored.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/roles": { "get": { "operationId": "listRoles", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The roles of this site with their permission sets, field and language limits included.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "post": { "operationId": "createRole", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCreate" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleCreateResponse" } } }, "description": "Created." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Create a role. Unknown permissions answer 400 `invalid_permissions` with every reason; a set beyond the credential answers 403 `escalation_refused`.", "x-audited": true, "x-destructive": false, "x-scope": "roles:write" } }, "/roles/{id}": { "get": { "operationId": "getRole", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One role of this site.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" }, "put": { "operationId": "updateRole", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change a role’s name, description or whole permission set, under the same rules as create. Refused 409 `last_administrator` when it would leave nobody able to grant access.", "x-audited": true, "x-destructive": true, "x-scope": "roles:write" } }, "/roles/{id}/remove": { "post": { "operationId": "deleteRole", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleDeleteResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Delete a custom role nobody holds. Refused 409 `system_role_delete_refused`, `role_in_use`, `role_in_access_rules` or `last_administrator`.", "x-audited": true, "x-destructive": true, "x-scope": "roles:write" } }, "/settings/chrome": { "get": { "operationId": "getChromeDefaults", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChromeDefaultsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The footer note, the named routes and the template regions from the accepted Site Chrome.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateChromeDefaults", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChromeDefaultsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChromeDefaultsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change the footer note, the named routes or the template regions as a new accepted Site Chrome version. Pinned to the revision read; unaccepted Site Chrome changes are kept. A changed region the template does not declare is refused (`unknown_region`), as are an unknown item (`unknown_region_item`) and a Blog item on a Website (`region_item_unavailable`).", "x-audited": true, "x-destructive": true, "x-scope": "settings:write" } }, "/settings/editorial": { "get": { "operationId": "getEditorialSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorialSettingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "How many versions each entry keeps, and whether entries pass through review.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateEditorialSettings", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorialSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditorialSettingsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change version retention or review, each pinned to the revision read.", "x-audited": true, "x-destructive": true, "x-scope": "settings:write" } }, "/settings/language-fallback": { "get": { "operationId": "getLanguageFallback", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageFallbackResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "What a read shows when content is missing in the language asked for: strict, or fallback languages in order.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateLanguageFallback", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageFallbackUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageFallbackUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change the missing-language policy or the fallback languages, each pinned to the revision read.", "x-audited": true, "x-destructive": true, "x-scope": "settings:write" } }, "/settings/media-files": { "get": { "operationId": "getMediaFileSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileSettingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Which kinds of file the media library takes, each with its size cap, and the limits a cap must keep to.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateMediaFileSettings", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaFileSettingsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Turn kinds of file on or off and set their size caps, pinned to the revision read. Stored files are kept.", "x-audited": true, "x-destructive": false, "x-scope": "settings:write" } }, "/settings/search": { "get": { "operationId": "getSearchSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSettingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Site search: on or off, the other models searched, how each searched model is tuned, and what may be added or tuned. Needs the creator to hold site:infra.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateSearchSettings", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchSettingsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Replace the site search setting with its tuning, pinned to the revision read. Needs the creator to hold site:infra.", "x-audited": true, "x-destructive": false, "x-scope": "settings:write" } }, "/settings/seo": { "get": { "operationId": "getSeoSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoSettingsResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Search and sharing defaults, the sitemap, robots rules and redirects from the accepted Site Chrome.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" }, "put": { "operationId": "updateSeoSettings", "parameters": [ { "description": "Reuse the same key and body on every retry. A key reused for a different request is refused.", "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "pattern": "^[\\x21-\\x7e]{1,128}$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoSettingsUpdate" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeoSettingsUpdateResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Change search and sharing defaults, the sitemap, robots rules or redirects as a new accepted Site Chrome version. Pinned to the revision read; unaccepted Site Chrome changes are kept.", "x-audited": true, "x-destructive": true, "x-scope": "settings:write" } }, "/settings/seo/redirect-review": { "post": { "operationId": "reviewRedirects", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectReviewRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedirectReviewResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "Which live addresses each pattern redirect covers, and the digest a save that changes a pattern must name. Writes nothing.", "x-audited": false, "x-destructive": false, "x-scope": "settings:write" } }, "/site": { "get": { "operationId": "getSite", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteContextResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "The site, credential and acting person this credential resolves to.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } }, "/trash": { "get": { "operationId": "listTrash", "parameters": [ { "in": "query", "name": "model_id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "1 to 50, default 20.", "pattern": "^\\d{1,2}$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrashListResponse" } } }, "description": "OK." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorBody" } } }, "description": "Refusal. Branch on `reason`; `error` is for a person." } }, "security": [ { "managementCredential": [] } ], "summary": "One model’s Trash: whole entries and languages moved there on their own, by id, in pages.", "x-audited": false, "x-destructive": false, "x-scope": "content:read" } } }, "servers": [ { "url": "/api/manage/v1" } ], "x-rate-limit": { "requests": 120, "window_seconds": 60 }, "x-reasons": { "audit_unavailable": { "message": "The audit record could not be written, so nothing ran.", "status": 503 }, "creator_unauthorized": { "message": "The person who created this credential is inactive or no longer holds this site, or the site is inactive.", "status": 403 }, "credential_invalid": { "message": "The credential is missing, unknown or revoked.", "status": 401 }, "idempotency_key_required": { "message": "This command needs an Idempotency-Key header (1-128 printable ASCII).", "status": 400 }, "invalid_request": { "message": "The request does not match the v1 contract.", "status": 400 }, "listing_owner_restricted": { "message": "The creator may read only their own entries of this model. Read them by id instead.", "status": 403 }, "rate_limited": { "message": "Too many requests for this credential. Respect Retry-After.", "status": 429 }, "scope_refused": { "message": "This credential was not granted the scope this command needs.", "status": 403 }, "temporary_failure": { "message": "The request did not finish. Try again shortly; retry a keyed command with the same Idempotency-Key and body.", "status": 503 } }, "x-scopes": [ "content:read", "content:write", "content:propose", "pages:write", "media:write", "lifecycle:publish", "content:trash", "content:purge", "workflow:move", "workflow:assign", "settings:write", "schema:propose", "schema:write", "plugins:use", "data:import", "data:export", "roles:write" ] }