{ "openapi": "3.1.0", "info": { "title": "Short Korea Site API", "version": "1.0.0", "description": "Site deployment and the automatically injected short SDK. Read /llms-full.txt for the generation contract and deployment workflow. OwnerToken is a Firebase ID token or 7-day development token. VisitorToken is a project session held by the host." }, "servers": [ { "url": "https://짧은.한국" } ], "paths": { "/api/sites/config": { "get": { "summary": "Effective free quotas and service status", "operationId": "get__api_sites_config", "security": [], "parameters": [], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites": { "get": { "summary": "Owned projects and account usage", "operationId": "get__api_sites", "security": [ { "OwnerToken": [] } ], "parameters": [], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "projects": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "usage": { "type": "object", "properties": {} }, "limits": { "$ref": "#/components/schemas/Limits" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Reserve a project and short suffix", "operationId": "post__api_sites", "security": [ { "OwnerToken": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 100 }, "slug": { "type": "string", "pattern": "^[가-힣A-Za-z0-9]{2,10}$" }, "sharedBy": { "type": "string", "minLength": 1, "maxLength": 10 }, "retentionDays": { "type": "integer", "enum": [ 30, 90, 365 ], "default": 30 } }, "required": [ "title", "slug", "sharedBy" ] } } } }, "responses": { "201": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}": { "get": { "summary": "Project, deployments and usage", "operationId": "get__api_sites_site_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" }, "deployments": { "type": "array", "items": { "$ref": "#/components/schemas/Deployment" } }, "usage": { "type": "object", "properties": {} }, "limits": { "$ref": "#/components/schemas/Limits" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Pause or resume publishing", "operationId": "patch__api_sites_site_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "active", "paused" ] } } } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Move a project to recoverable deletion for 30 days", "operationId": "delete__api_sites_site_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/renew": { "post": { "summary": "Recover a project for 90 days during its 30-day deletion waiting period", "operationId": "post__api_sites_site_renew", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/extend": { "post": { "summary": "Extend by 90 days during the final 7 days", "operationId": "post__api_sites_site_extend", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/deployments": { "post": { "summary": "Reserve single-HTML deployment storage", "operationId": "post__api_sites_site_deployments", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "assets": { "type": "array", "minItems": 1, "maxItems": 1, "items": { "$ref": "#/components/schemas/UploadAsset" } } }, "required": [ "assets" ] } } } }, "responses": { "201": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "deploymentId": { "type": "string" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } }, "expiresAt": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/deployments/{deployment}/assets/{asset}": { "put": { "summary": "Upload original bytes matching SHA-256 and size", "operationId": "put__api_sites_site_deployments_deployment_assets_asset_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "uploaded": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "get": { "summary": "Download original HTML for editing", "operationId": "get__api_sites_site_deployments_deployment_assets_asset_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "asset", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Original bytes", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "429": { "description": "Transfer quota" } } } }, "/api/sites/{site}/deployments/{deployment}/publish": { "post": { "summary": "Atomically publish a validated version and optional editable project details", "operationId": "post__api_sites_site_deployments_deployment_publish", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "details": { "$ref": "#/components/schemas/EditableProjectDetails" }, "expectedDeploymentId": { "type": [ "string", "null" ], "description": "Optional optimistic concurrency guard: current active deployment ID, or null for an unpublished project" } } } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/deployments/{deployment}/restore": { "post": { "summary": "Restore a retained version", "operationId": "post__api_sites_site_deployments_deployment_restore", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "project": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/deployments/{deployment}": { "delete": { "summary": "Cancel an upload or remove an inactive version", "operationId": "delete__api_sites_site_deployments_deployment_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "deployment", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/session": { "post": { "summary": "Issue a visitor session", "operationId": "post__api_sites_site_session", "security": [], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "visitorKey": { "type": "string", "pattern": "^[A-Za-z0-9_-]{32,64}$" } } } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "project": { "type": "object", "properties": { "siteId": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" } } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/runtime/collections/{collection}/records": { "get": { "summary": "List records allowed by access policy", "operationId": "get__api_sites_site_runtime_collections_collection_records", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "default": 20, "minimum": 1, "maximum": 50 } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Record" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Create a record", "operationId": "post__api_sites_site_runtime_collections_collection_records", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordData" } } } }, "responses": { "201": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Record" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/runtime/collections/{collection}/records/{record}": { "get": { "summary": "Read a record", "operationId": "get__api_sites_site_runtime_collections_collection_records_record_", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Record" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Replace an owned record data object", "operationId": "put__api_sites_site_runtime_collections_collection_records_record_", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordData" } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "record": { "$ref": "#/components/schemas/Record" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Delete an owned record", "operationId": "delete__api_sites_site_runtime_collections_collection_records_record_", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/runtime/files": { "get": { "summary": "List files allowed by access policy", "operationId": "get__api_sites_site_runtime_files", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/StoredFile" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Upload a visitor file", "operationId": "post__api_sites_site_runtime_files", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "description": "Filename", "schema": { "type": "string" } }, { "name": "X-File-Type", "in": "header", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "$ref": "#/components/schemas/StoredFile" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } }, "/api/sites/{site}/runtime/files/{file}/url": { "get": { "summary": "Issue a file display URL", "operationId": "get__api_sites_site_runtime_files_file_url", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/runtime/files/{file}": { "delete": { "summary": "Delete an owned file", "operationId": "delete__api_sites_site_runtime_files_file_", "security": [ { "VisitorToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/files/{file}": { "get": { "summary": "Read a file using a public or signed URL", "operationId": "get__api_sites_site_files_file_", "security": [], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "access", "in": "query", "description": "Signed access value for a visitor file", "schema": { "type": "string" } } ], "responses": { "200": { "description": "File bytes" }, "403": { "description": "File access denied" }, "429": { "description": "Transfer quota" } } } }, "/api/sites/{site}/manage/collections": { "get": { "summary": "List all project collections as owner", "operationId": "get__api_sites_site_manage_collections", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "collections": { "type": "array", "items": { "type": "string" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/manage/collections/{collection}/records": { "get": { "summary": "List project records as owner", "operationId": "get__api_sites_site_manage_collections_collection_records", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "records": { "type": "array", "items": { "$ref": "#/components/schemas/Record" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/manage/collections/{collection}/records/{record}": { "put": { "summary": "Replace a complete record data object as owner", "operationId": "put__api_sites_site_manage_collections_collection_records_record_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordData" } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Delete a record as owner", "operationId": "delete__api_sites_site_manage_collections_collection_records_record_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "record", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/manage/files": { "get": { "summary": "List all project files as owner", "operationId": "get__api_sites_site_manage_files", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "files": { "type": "array", "items": { "$ref": "#/components/schemas/StoredFile" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/{site}/manage/files/{file}": { "get": { "summary": "Download an original file as owner", "operationId": "get__api_sites_site_manage_files_file_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "File bytes" }, "429": { "description": "Transfer quota" } } }, "delete": { "summary": "Delete a file as owner", "operationId": "delete__api_sites_site_manage_files_file_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "site", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/developer-tokens": { "get": { "summary": "List development tokens", "operationId": "get__api_sites_developer_tokens", "security": [ { "OwnerToken": [] } ], "parameters": [], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "tokens": { "type": "array", "items": { "type": "object", "properties": { "tokenId": { "type": "string" }, "expiresAt": { "type": "string" }, "revoked": { "type": "boolean" } } } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Issue a 7-day development token using login credentials", "operationId": "post__api_sites_developer_tokens", "security": [ { "OwnerToken": [] } ], "parameters": [], "responses": { "201": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "tokenId": { "type": "string" }, "token": { "type": "string" }, "expiresAt": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/developer-tokens/{tokenId}": { "delete": { "summary": "Revoke a development token using login credentials", "operationId": "delete__api_sites_developer_tokens_tokenId_", "security": [ { "OwnerToken": [] } ], "parameters": [ { "name": "tokenId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/sites/admin/settings": { "patch": { "summary": "Update quotas and service status as administrator", "operationId": "patch__api_sites_admin_settings", "security": [ { "OwnerToken": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Limits" } } } } } }, "responses": { "200": { "description": "Completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Settings" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Access denied", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "State conflict or storage quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Request or transfer quota", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "OwnerToken": { "type": "http", "scheme": "bearer" }, "VisitorToken": { "type": "http", "scheme": "bearer" } }, "schemas": { "EditableProjectDetails": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 100 }, "slug": { "type": "string", "pattern": "^[가-힣A-Za-z0-9]{2,10}$" }, "sharedBy": { "type": "string", "minLength": 1, "maxLength": 10 }, "retentionDays": { "type": "integer", "enum": [ 30, 90, 365 ] } }, "required": [ "title", "slug", "sharedBy", "retentionDays" ], "additionalProperties": false }, "Project": { "type": "object", "properties": { "siteId": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "sharedBy": { "type": "string" }, "shortUrl": { "type": "string" }, "status": { "enum": [ "draft", "active", "paused", "deletion_pending", "deleting", "deleted" ] }, "activeDeploymentId": { "type": "string" }, "retentionDays": { "type": "integer", "enum": [ 30, 90, 365 ] }, "expiresAt": { "type": "string" }, "deletionDueAt": { "type": "string" }, "canRenew": { "type": "boolean" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "storageBytes": { "type": "integer" }, "databaseBytes": { "type": "integer" }, "recordCount": { "type": "integer" }, "collectionCount": { "type": "integer" }, "fileCount": { "type": "integer" }, "policy": { "$ref": "#/components/schemas/Policy" } } }, "UploadAsset": { "type": "object", "properties": { "path": { "const": "index.html" }, "size": { "type": "integer", "minimum": 1, "maximum": 2097152 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "path", "size", "sha256" ] }, "Asset": { "allOf": [ { "$ref": "#/components/schemas/UploadAsset" }, { "type": "object", "properties": { "id": { "type": "string" }, "mimeType": { "type": "string" } } } ] }, "Deployment": { "type": "object", "properties": { "deploymentId": { "type": "string" }, "status": { "type": "string" }, "totalBytes": { "type": "integer" }, "createdAt": { "type": "string" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } } } }, "RecordData": { "type": "object", "additionalProperties": true, "description": "UTF-8 JSON up to 16 KiB, nesting up to 10 levels and up to 1,000 fields in total" }, "Record": { "type": "object", "properties": { "id": { "type": "string" }, "data": { "$ref": "#/components/schemas/RecordData" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "StoredFile": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "integer" }, "mimeType": { "type": "string" }, "createdAt": { "type": "string" } } }, "Policy": { "type": "object", "properties": { "version": { "const": 1 }, "collections": { "type": "object", "maxProperties": 100, "additionalProperties": { "type": "object", "properties": { "access": { "enum": [ "visitor", "public", "submit", "private" ] } } } }, "files": { "type": "object", "properties": { "access": { "enum": [ "visitor", "public", "private" ] } } }, "spa": { "type": "boolean", "default": false } } }, "Limits": { "type": "object", "additionalProperties": { "type": "integer", "minimum": 1 } }, "Settings": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Limits" } } }, "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } }