Files
flexly-cms/specs/001-antirion-admin/openapi.json
T

7544 lines
194 KiB
JSON

{
"components": {
"schemas": {
"Add": {
"additionalProperties": false,
"properties": {
"fragment": {
"title": "Fragment",
"type": "string"
},
"parent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent"
},
"props": {
"additionalProperties": true,
"title": "Props",
"type": "object"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region"
},
"slot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Slot"
},
"type": {
"const": "add",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"fragment"
],
"title": "Add",
"type": "object"
},
"BlockAction": {
"additionalProperties": false,
"properties": {
"block_id": {
"title": "Block Id",
"type": "string"
},
"type": {
"enum": [
"block",
"delete",
"toggle",
"duplicate"
],
"title": "Type",
"type": "string"
},
"values": {
"$ref": "#/components/schemas/BlockValues"
}
},
"required": [
"type",
"block_id"
],
"title": "BlockAction",
"type": "object"
},
"BlockLayoutDTO": {
"additionalProperties": false,
"properties": {
"content_width": {
"default": "inherit",
"enum": [
"inherit",
"boxed",
"fluid",
"full"
],
"title": "Content Width",
"type": "string"
},
"section_width": {
"default": "inherit",
"enum": [
"inherit",
"boxed",
"fluid",
"full"
],
"title": "Section Width",
"type": "string"
}
},
"title": "BlockLayoutDTO",
"type": "object"
},
"BlockValues": {
"additionalProperties": false,
"properties": {
"anchor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Anchor"
},
"hidden": {
"title": "Hidden",
"type": "boolean"
},
"layout": {
"$ref": "#/components/schemas/BlockLayoutDTO"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note"
},
"props": {
"additionalProperties": true,
"title": "Props",
"type": "object"
},
"requires": {
"items": {
"type": "string"
},
"title": "Requires",
"type": "array"
}
},
"title": "BlockValues",
"type": "object"
},
"Buffer": {
"additionalProperties": false,
"properties": {
"etag": {
"maxLength": 80,
"minLength": 1,
"title": "Etag",
"type": "string"
},
"revision": {
"default": 0,
"minimum": 0.0,
"title": "Revision",
"type": "integer"
},
"source": {
"maxLength": 524288,
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"etag"
],
"title": "Buffer",
"type": "object"
},
"CollectionRow": {
"additionalProperties": false,
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"published": {
"title": "Published",
"type": "integer"
},
"total": {
"title": "Total",
"type": "integer"
}
},
"required": [
"id",
"name",
"total",
"published"
],
"title": "CollectionRow",
"type": "object"
},
"Create": {
"additionalProperties": false,
"properties": {
"id": {
"maxLength": 200,
"minLength": 1,
"title": "Id",
"type": "string"
},
"layout": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Layout"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
}
},
"required": [
"id"
],
"title": "Create",
"type": "object"
},
"EditorUpdate": {
"additionalProperties": false,
"properties": {
"etag": {
"maxLength": 80,
"minLength": 1,
"title": "Etag",
"type": "string"
},
"operations": {
"items": {
"anyOf": [
{
"discriminator": {
"mapping": {
"add": "#/components/schemas/Add",
"block": "#/components/schemas/BlockAction",
"delete": "#/components/schemas/BlockAction",
"duplicate": "#/components/schemas/BlockAction",
"entry_fields": "#/components/schemas/EntryFields",
"metadata": "#/components/schemas/Metadata",
"move": "#/components/schemas/Move",
"toggle": "#/components/schemas/BlockAction"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Metadata"
},
{
"$ref": "#/components/schemas/EntryFields"
},
{
"$ref": "#/components/schemas/BlockAction"
},
{
"$ref": "#/components/schemas/Add"
},
{
"$ref": "#/components/schemas/Move"
}
]
},
{
"$ref": "#/components/schemas/InspectorEdit"
}
]
},
"maxItems": 100,
"title": "Operations",
"type": "array"
},
"revision": {
"default": 0,
"minimum": 0.0,
"title": "Revision",
"type": "integer"
},
"source": {
"maxLength": 524288,
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"etag"
],
"title": "EditorUpdate",
"type": "object"
},
"EditorUpdateResult": {
"additionalProperties": false,
"properties": {
"preview": {
"anyOf": [
{
"$ref": "#/components/schemas/Preview"
},
{
"type": "null"
}
]
},
"preview_error": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorBody"
},
{
"type": "null"
}
]
},
"snapshot": {
"$ref": "#/components/schemas/Snapshot"
}
},
"required": [
"snapshot"
],
"title": "EditorUpdateResult",
"type": "object"
},
"Entries": {
"additionalProperties": false,
"properties": {
"collection": {
"$ref": "#/components/schemas/CollectionRow"
},
"entries": {
"items": {
"$ref": "#/components/schemas/EntryRow"
},
"title": "Entries",
"type": "array"
}
},
"required": [
"collection",
"entries"
],
"title": "Entries",
"type": "object"
},
"EntryFields": {
"additionalProperties": false,
"properties": {
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"status": {
"anyOf": [
{
"enum": [
"draft",
"published",
"archived"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Status"
},
"type": {
"const": "entry_fields",
"title": "Type",
"type": "string"
},
"unset": {
"items": {
"type": "string"
},
"title": "Unset",
"type": "array"
},
"values": {
"additionalProperties": true,
"title": "Values",
"type": "object"
}
},
"required": [
"type"
],
"title": "EntryFields",
"type": "object"
},
"EntryRow": {
"additionalProperties": false,
"properties": {
"file": {
"title": "File",
"type": "string"
},
"route": {
"title": "Route",
"type": "string"
},
"slug": {
"title": "Slug",
"type": "string"
},
"status": {
"title": "Status",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"slug",
"title",
"status",
"route",
"file"
],
"title": "EntryRow",
"type": "object"
},
"ErrorBody": {
"additionalProperties": false,
"properties": {
"base_etag": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Etag"
},
"buffer": {
"anyOf": [
{
"$ref": "#/components/schemas/Snapshot"
},
{
"type": "null"
}
]
},
"code": {
"title": "Code",
"type": "string"
},
"committed": {
"anyOf": [
{
"$ref": "#/components/schemas/Snapshot"
},
{
"$ref": "#/components/schemas/ThemeSnapshot"
},
{
"type": "null"
}
],
"title": "Committed"
},
"current": {
"anyOf": [
{
"$ref": "#/components/schemas/Snapshot"
},
{
"$ref": "#/components/schemas/ThemeSnapshot"
},
{
"type": "null"
}
],
"title": "Current"
},
"issues": {
"items": {
"$ref": "#/components/schemas/IssueDTO"
},
"title": "Issues",
"type": "array"
},
"message": {
"title": "Message",
"type": "string"
},
"request_id": {
"title": "Request Id",
"type": "string"
},
"revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Revision"
},
"submitted": {
"anyOf": [
{
"$ref": "#/components/schemas/Buffer"
},
{
"type": "null"
}
]
},
"submitted_source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Submitted Source"
}
},
"required": [
"code",
"message",
"request_id"
],
"title": "ErrorBody",
"type": "object"
},
"ErrorEnvelope": {
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorBody"
}
},
"required": [
"error"
],
"title": "ErrorEnvelope",
"type": "object"
},
"InspectorEdit": {
"additionalProperties": false,
"properties": {
"fields": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"title": "Fields",
"type": "object"
},
"type": {
"const": "inspector",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"fields"
],
"title": "InspectorEdit",
"type": "object"
},
"IssueDTO": {
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"hint": {
"default": "",
"title": "Hint",
"type": "string"
},
"message": {
"title": "Message",
"type": "string"
},
"path": {
"default": "",
"title": "Path",
"type": "string"
},
"severity": {
"default": "error",
"title": "Severity",
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "IssueDTO",
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"properties": {
"body": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Body"
},
"type": {
"const": "metadata",
"title": "Type",
"type": "string"
},
"values": {
"additionalProperties": true,
"title": "Values",
"type": "object"
}
},
"required": [
"type"
],
"title": "Metadata",
"type": "object"
},
"Move": {
"additionalProperties": false,
"properties": {
"after": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "After"
},
"before": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Before"
},
"block_id": {
"title": "Block Id",
"type": "string"
},
"direction": {
"anyOf": [
{
"enum": [
"up",
"down"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Direction"
},
"type": {
"const": "move",
"title": "Type",
"type": "string"
}
},
"required": [
"type",
"block_id"
],
"title": "Move",
"type": "object"
},
"OnboardingState": {
"additionalProperties": false,
"properties": {
"can_manage": {
"title": "Can Manage",
"type": "boolean"
},
"needs_setup": {
"title": "Needs Setup",
"type": "boolean"
},
"status": {
"enum": [
"new",
"existing",
"in_progress",
"skipped",
"completed"
],
"title": "Status",
"type": "string"
}
},
"required": [
"status",
"needs_setup",
"can_manage"
],
"title": "OnboardingState",
"type": "object"
},
"PageRow": {
"additionalProperties": false,
"properties": {
"changed": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Changed"
},
"count": {
"title": "Count",
"type": "integer"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"file": {
"title": "File",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"issues": {
"items": {
"$ref": "#/components/schemas/IssueDTO"
},
"title": "Issues",
"type": "array"
},
"layout": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Layout"
},
"on_live": {
"default": false,
"title": "On Live",
"type": "boolean"
},
"route": {
"title": "Route",
"type": "string"
},
"status": {
"title": "Status",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"updated_at": {
"default": "",
"title": "Updated At",
"type": "string"
}
},
"required": [
"id",
"title",
"status",
"route",
"file",
"layout",
"count"
],
"title": "PageRow",
"type": "object"
},
"Preview": {
"additionalProperties": false,
"properties": {
"expires_at": {
"title": "Expires At",
"type": "number"
},
"html": {
"default": "",
"title": "Html",
"type": "string"
},
"interactive": {
"title": "Interactive",
"type": "boolean"
},
"message": {
"default": "",
"title": "Message",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"snapshot": {
"default": "",
"title": "Snapshot",
"type": "string"
},
"url": {
"default": "",
"title": "Url",
"type": "string"
}
},
"required": [
"revision",
"interactive",
"expires_at"
],
"title": "Preview",
"type": "object"
},
"Release": {
"additionalProperties": false,
"properties": {
"current": {
"title": "Current",
"type": "boolean"
},
"id": {
"title": "Id",
"type": "string"
}
},
"required": [
"id",
"current"
],
"title": "Release",
"type": "object"
},
"Releases": {
"additionalProperties": false,
"properties": {
"builds": {
"items": {
"$ref": "#/components/schemas/Release"
},
"title": "Builds",
"type": "array"
},
"current": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Current"
}
},
"required": [
"current",
"builds"
],
"title": "Releases",
"type": "object"
},
"Rollback": {
"additionalProperties": false,
"properties": {
"build_id": {
"pattern": "^\\d{8}T\\d{6}-[0-9a-f]{8}$",
"title": "Build Id",
"type": "string"
}
},
"required": [
"build_id"
],
"title": "Rollback",
"type": "object"
},
"Snapshot": {
"additionalProperties": false,
"properties": {
"etag": {
"title": "Etag",
"type": "string"
},
"id": {
"title": "Id",
"type": "string"
},
"issues": {
"items": {
"$ref": "#/components/schemas/IssueDTO"
},
"title": "Issues",
"type": "array"
},
"kind": {
"enum": [
"page",
"entry"
],
"title": "Kind",
"type": "string"
},
"model": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Model"
},
"path": {
"title": "Path",
"type": "string"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"schema": {
"additionalProperties": true,
"title": "Schema",
"type": "object"
},
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"kind",
"id",
"path",
"source",
"etag",
"model",
"issues",
"schema"
],
"title": "Snapshot",
"type": "object"
},
"ThemePresets": {
"additionalProperties": false,
"properties": {
"allowed_fonts": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"title": "Allowed Fonts",
"type": "array"
},
"fonts": {
"additionalProperties": true,
"title": "Fonts",
"type": "object"
},
"presets": {
"additionalProperties": true,
"title": "Presets",
"type": "object"
}
},
"required": [
"presets",
"fonts",
"allowed_fonts"
],
"title": "ThemePresets",
"type": "object"
},
"ThemePreviewRequest": {
"additionalProperties": false,
"properties": {
"device": {
"default": "desktop",
"enum": [
"desktop",
"phone"
],
"title": "Device",
"type": "string"
},
"document": {
"additionalProperties": true,
"title": "Document",
"type": "object"
},
"page_id": {
"default": "",
"maxLength": 200,
"title": "Page Id",
"type": "string"
},
"revision": {
"default": 0,
"minimum": 0.0,
"title": "Revision",
"type": "integer"
},
"target": {
"default": "sample",
"enum": [
"sample",
"page"
],
"title": "Target",
"type": "string"
},
"viewport_width": {
"default": 1440,
"maximum": 3840.0,
"minimum": 320.0,
"title": "Viewport Width",
"type": "integer"
}
},
"required": [
"document"
],
"title": "ThemePreviewRequest",
"type": "object"
},
"ThemeSnapshot": {
"additionalProperties": false,
"properties": {
"contrast": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Contrast"
},
"css": {
"title": "Css",
"type": "string"
},
"diagnostics": {
"items": {
"$ref": "#/components/schemas/IssueDTO"
},
"title": "Diagnostics",
"type": "array"
},
"document": {
"additionalProperties": true,
"title": "Document",
"type": "object"
},
"effective_tokens": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Effective Tokens"
},
"etag": {
"title": "Etag",
"type": "string"
},
"live_build_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Live Build Id"
},
"path": {
"title": "Path",
"type": "string"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"workspace_revision": {
"title": "Workspace Revision",
"type": "string"
},
"yaml": {
"title": "Yaml",
"type": "string"
}
},
"required": [
"document",
"etag",
"effective_tokens",
"workspace_revision",
"live_build_id",
"path",
"yaml",
"css",
"contrast"
],
"title": "ThemeSnapshot",
"type": "object"
},
"ThemeUpdate": {
"additionalProperties": false,
"properties": {
"document": {
"additionalProperties": true,
"title": "Document",
"type": "object"
},
"if_match": {
"maxLength": 80,
"minLength": 1,
"title": "If Match",
"type": "string"
},
"revision": {
"default": 0,
"minimum": 0.0,
"title": "Revision",
"type": "integer"
}
},
"required": [
"document",
"if_match"
],
"title": "ThemeUpdate",
"type": "object"
},
"Transform": {
"additionalProperties": false,
"properties": {
"action": {
"discriminator": {
"mapping": {
"add": "#/components/schemas/Add",
"block": "#/components/schemas/BlockAction",
"delete": "#/components/schemas/BlockAction",
"duplicate": "#/components/schemas/BlockAction",
"entry_fields": "#/components/schemas/EntryFields",
"metadata": "#/components/schemas/Metadata",
"move": "#/components/schemas/Move",
"toggle": "#/components/schemas/BlockAction"
},
"propertyName": "type"
},
"oneOf": [
{
"$ref": "#/components/schemas/Metadata"
},
{
"$ref": "#/components/schemas/EntryFields"
},
{
"$ref": "#/components/schemas/BlockAction"
},
{
"$ref": "#/components/schemas/Add"
},
{
"$ref": "#/components/schemas/Move"
}
],
"title": "Action"
},
"etag": {
"maxLength": 80,
"minLength": 1,
"title": "Etag",
"type": "string"
},
"revision": {
"default": 0,
"minimum": 0.0,
"title": "Revision",
"type": "integer"
},
"source": {
"maxLength": 524288,
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"etag",
"action"
],
"title": "Transform",
"type": "object"
},
"Workspace": {
"additionalProperties": false,
"properties": {
"collections": {
"items": {
"$ref": "#/components/schemas/CollectionRow"
},
"title": "Collections",
"type": "array"
},
"comparison_available": {
"default": false,
"title": "Comparison Available",
"type": "boolean"
},
"issues": {
"items": {
"$ref": "#/components/schemas/IssueDTO"
},
"title": "Issues",
"type": "array"
},
"layouts": {
"items": {
"type": "string"
},
"title": "Layouts",
"type": "array"
},
"pages": {
"items": {
"$ref": "#/components/schemas/PageRow"
},
"title": "Pages",
"type": "array"
},
"paths": {
"additionalProperties": {
"type": "string"
},
"title": "Paths",
"type": "object"
},
"release": {
"$ref": "#/components/schemas/WorkspaceRelease"
},
"site_name": {
"title": "Site Name",
"type": "string"
}
},
"required": [
"site_name",
"pages",
"collections",
"layouts",
"issues",
"paths"
],
"title": "Workspace",
"type": "object"
},
"WorkspaceRelease": {
"additionalProperties": false,
"properties": {
"built_at": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Built At"
},
"current": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Current"
},
"routes": {
"items": {
"type": "string"
},
"title": "Routes",
"type": "array"
}
},
"title": "WorkspaceRelease",
"type": "object"
}
},
"securitySchemes": {
"InternalUiSession": {
"description": "Request-scoped server credential; never sent to the browser",
"scheme": "bearer",
"type": "http"
}
}
},
"info": {
"title": "Site Engine Admin API",
"version": "1.0.0"
},
"openapi": "3.1.0",
"paths": {
"/admin/api/v1/assets/{asset}": {
"get": {
"operationId": "asset_admin_api_v1_assets__asset__get",
"parameters": [
{
"in": "path",
"name": "asset",
"required": true,
"schema": {
"title": "Asset",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Asset"
}
},
"/admin/api/v1/collections": {
"get": {
"operationId": "collections_admin_api_v1_collections_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/CollectionRow"
},
"title": "Response Collections Admin Api V1 Collections Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Collections"
}
},
"/admin/api/v1/collections/{collection}/entries": {
"get": {
"operationId": "entry_list_admin_api_v1_collections__collection__entries_get",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"default": "",
"title": "Q",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"default": "",
"title": "Status",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Entries"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry List"
},
"post": {
"operationId": "entry_create_admin_api_v1_collections__collection__entries_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Create"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/preview": {
"post": {
"operationId": "entry_preview_admin_api_v1_collections__collection__entries__identity__preview_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preview"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Preview"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/save": {
"post": {
"operationId": "entry_save_admin_api_v1_collections__collection__entries__identity__save_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Save"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/source": {
"get": {
"operationId": "entry_source_admin_api_v1_collections__collection__entries__identity__source_get",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Source"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/transform": {
"post": {
"operationId": "entry_transform_admin_api_v1_collections__collection__entries__identity__transform_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transform"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Transform"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/update": {
"post": {
"operationId": "entry_update_admin_api_v1_collections__collection__entries__identity__update_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdateResult"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Update"
}
},
"/admin/api/v1/collections/{collection}/entries/{identity}/validate": {
"post": {
"operationId": "entry_validate_admin_api_v1_collections__collection__entries__identity__validate_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Validate"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/preview": {
"post": {
"operationId": "entry_preview_admin_api_v1_editor_entries__collection___identity__preview_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preview"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Preview"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/save": {
"post": {
"operationId": "entry_save_admin_api_v1_editor_entries__collection___identity__save_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Save"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/source": {
"get": {
"operationId": "entry_source_admin_api_v1_editor_entries__collection___identity__source_get",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Source"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/transform": {
"post": {
"operationId": "entry_transform_admin_api_v1_editor_entries__collection___identity__transform_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transform"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Transform"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/update": {
"post": {
"operationId": "entry_update_admin_api_v1_editor_entries__collection___identity__update_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdateResult"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Update"
}
},
"/admin/api/v1/editor/entries/{collection}/{identity}/validate": {
"post": {
"operationId": "entry_validate_admin_api_v1_editor_entries__collection___identity__validate_post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Validate"
}
},
"/admin/api/v1/editor/pages/{identity}/preview": {
"post": {
"operationId": "page_preview_admin_api_v1_editor_pages__identity__preview_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preview"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Preview"
}
},
"/admin/api/v1/editor/pages/{identity}/save": {
"post": {
"operationId": "page_save_admin_api_v1_editor_pages__identity__save_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Save"
}
},
"/admin/api/v1/editor/pages/{identity}/source": {
"get": {
"operationId": "page_source_admin_api_v1_editor_pages__identity__source_get",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Source"
}
},
"/admin/api/v1/editor/pages/{identity}/transform": {
"post": {
"operationId": "page_transform_admin_api_v1_editor_pages__identity__transform_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transform"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Transform"
}
},
"/admin/api/v1/editor/pages/{identity}/update": {
"post": {
"operationId": "page_update_admin_api_v1_editor_pages__identity__update_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdateResult"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Update"
}
},
"/admin/api/v1/editor/pages/{identity}/validate": {
"post": {
"operationId": "page_validate_admin_api_v1_editor_pages__identity__validate_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Validate"
}
},
"/admin/api/v1/entries/{collection}": {
"get": {
"operationId": "entry_list_admin_api_v1_entries__collection__get",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
},
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"default": "",
"title": "Q",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"default": "",
"title": "Status",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Entries"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry List"
},
"post": {
"operationId": "entry_create_admin_api_v1_entries__collection__post",
"parameters": [
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"title": "Collection",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Entry Create"
}
},
"/admin/api/v1/pages": {
"get": {
"operationId": "page_list_admin_api_v1_pages_get",
"parameters": [
{
"in": "query",
"name": "q",
"required": false,
"schema": {
"default": "",
"title": "Q",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"default": "",
"title": "Status",
"type": "string"
}
},
{
"in": "query",
"name": "layout",
"required": false,
"schema": {
"default": "",
"title": "Layout",
"type": "string"
}
},
{
"in": "query",
"name": "changed",
"required": false,
"schema": {
"default": false,
"title": "Changed",
"type": "boolean"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/PageRow"
},
"title": "Response Page List Admin Api V1 Pages Get",
"type": "array"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page List"
},
"post": {
"operationId": "page_create_admin_api_v1_pages_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Create"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Create"
}
},
"/admin/api/v1/pages/{identity}/preview": {
"post": {
"operationId": "page_preview_admin_api_v1_pages__identity__preview_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preview"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Preview"
}
},
"/admin/api/v1/pages/{identity}/save": {
"post": {
"operationId": "page_save_admin_api_v1_pages__identity__save_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Save"
}
},
"/admin/api/v1/pages/{identity}/source": {
"get": {
"operationId": "page_source_admin_api_v1_pages__identity__source_get",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Source"
}
},
"/admin/api/v1/pages/{identity}/transform": {
"post": {
"operationId": "page_transform_admin_api_v1_pages__identity__transform_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Transform"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Transform"
}
},
"/admin/api/v1/pages/{identity}/update": {
"post": {
"operationId": "page_update_admin_api_v1_pages__identity__update_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditorUpdateResult"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Update"
}
},
"/admin/api/v1/pages/{identity}/validate": {
"post": {
"operationId": "page_validate_admin_api_v1_pages__identity__validate_post",
"parameters": [
{
"in": "path",
"name": "identity",
"required": true,
"schema": {
"title": "Identity",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Buffer"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Snapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Page Validate"
}
},
"/admin/api/v1/preview/{snapshot}/assets/{asset}": {
"get": {
"operationId": "preview_asset_admin_api_v1_preview__snapshot__assets__asset__get",
"parameters": [
{
"in": "path",
"name": "snapshot",
"required": true,
"schema": {
"title": "Snapshot",
"type": "string"
}
},
{
"in": "path",
"name": "asset",
"required": true,
"schema": {
"title": "Asset",
"type": "string"
}
},
{
"in": "query",
"name": "token",
"required": false,
"schema": {
"default": "",
"title": "Token",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Preview Asset"
}
},
"/admin/api/v1/preview/{snapshot}/html": {
"get": {
"operationId": "preview_html_admin_api_v1_preview__snapshot__html_get",
"parameters": [
{
"in": "path",
"name": "snapshot",
"required": true,
"schema": {
"title": "Snapshot",
"type": "string"
}
},
{
"in": "query",
"name": "token",
"required": false,
"schema": {
"default": "",
"title": "Token",
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Preview Html"
}
},
"/admin/api/v1/publish": {
"post": {
"operationId": "publish_site_admin_api_v1_publish_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Releases"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Publish Site"
}
},
"/admin/api/v1/releases": {
"get": {
"operationId": "release_list_admin_api_v1_releases_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Releases"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Release List"
}
},
"/admin/api/v1/rollback": {
"post": {
"operationId": "rollback_body_admin_api_v1_rollback_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Rollback"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Releases"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Rollback Body"
}
},
"/admin/api/v1/rollback/{build_id}": {
"post": {
"operationId": "rollback_site_admin_api_v1_rollback__build_id__post",
"parameters": [
{
"in": "path",
"name": "build_id",
"required": true,
"schema": {
"title": "Build Id",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Releases"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Rollback Site"
}
},
"/admin/api/v1/site": {
"get": {
"operationId": "site_admin_api_v1_site_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Workspace"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Site"
}
},
"/admin/api/v1/theme": {
"get": {
"operationId": "theme_get_admin_api_v1_theme_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemeSnapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Get"
},
"patch": {
"operationId": "theme_save_admin_api_v1_theme_patch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemeUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemeSnapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Save"
}
},
"/admin/api/v1/theme/onboarding": {
"get": {
"operationId": "theme_onboarding_admin_api_v1_theme_onboarding_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingState"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Onboarding"
}
},
"/admin/api/v1/theme/onboarding/restart": {
"post": {
"operationId": "theme_restart_admin_api_v1_theme_onboarding_restart_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingState"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Restart"
}
},
"/admin/api/v1/theme/onboarding/skip": {
"post": {
"operationId": "theme_skip_admin_api_v1_theme_onboarding_skip_post",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OnboardingState"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Skip"
}
},
"/admin/api/v1/theme/presets": {
"get": {
"operationId": "theme_presets_admin_api_v1_theme_presets_get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemePresets"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Presets"
}
},
"/admin/api/v1/theme/preview": {
"post": {
"operationId": "theme_preview_admin_api_v1_theme_preview_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemePreviewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preview"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Preview"
}
},
"/admin/api/v1/theme/validate": {
"post": {
"operationId": "theme_validate_admin_api_v1_theme_validate_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemePreviewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ThemeSnapshot"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Bad Request"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Not Found"
},
"405": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Method Not Allowed"
},
"409": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Conflict"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Request Entity Too Large"
},
"422": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Unprocessable Entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorEnvelope"
}
}
},
"description": "Internal Server Error"
}
},
"security": [
{
"InternalUiSession": []
}
],
"summary": "Theme Validate"
}
}
}
}