{ "components": { "schemas": { "ApiKeyCreate": { "properties": { "name": { "type": "string" }, "rate_limit_per_hour": { "default": 120, "minimum": 1, "type": "integer" }, "scopes": { "items": { "type": "string" }, "type": "array" } }, "required": [ "name", "scopes" ], "type": "object" }, "AvailabilityUpdate": { "additionalProperties": false, "properties": { "col_from": { "example": 0, "minimum": 0, "type": "integer" }, "col_to": { "example": 4, "minimum": 0, "type": "integer" }, "note": { "type": "string" }, "row_from": { "example": 0, "minimum": 0, "type": "integer" }, "row_to": { "example": 4, "minimum": 0, "type": "integer" }, "status": { "enum": [ "available", "unavailable" ], "type": "string" } }, "required": [ "row_from", "row_to", "col_from", "col_to", "status" ], "type": "object" }, "Block": { "properties": { "grid_id": { "type": "integer" }, "height": { "minimum": 1, "type": "integer" }, "id": { "type": "integer" }, "status": { "type": "string" }, "width": { "minimum": 1, "type": "integer" }, "x": { "minimum": 0, "type": "integer" }, "y": { "minimum": 0, "type": "integer" } }, "required": [ "id", "grid_id", "x", "y", "width", "height", "status" ], "type": "object" }, "BlockCoordinate": { "additionalProperties": false, "properties": { "col": { "example": 0, "minimum": 0, "type": "integer" }, "row": { "example": 0, "minimum": 0, "type": "integer" } }, "required": [ "row", "col" ], "type": "object" }, "Error": { "properties": { "code": { "type": "string" }, "data": { "additionalProperties": true, "properties": { "status": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "required": [ "code", "message", "data" ], "type": "object" }, "Grid": { "additionalProperties": true, "properties": { "block_height": { "minimum": 1, "type": "integer" }, "block_width": { "minimum": 1, "type": "integer" }, "currency": { "type": "string" }, "description": { "type": "string" }, "height": { "minimum": 1, "type": "integer" }, "id": { "type": "integer" }, "price_per_block": { "minimum": 0, "type": "number" }, "renderer_mode": { "type": "string" }, "slug": { "type": "string" }, "status": { "type": "string" }, "title": { "type": "string" }, "virtual_blocks": { "properties": { "columns": { "type": "integer" }, "rows": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" }, "width": { "minimum": 1, "type": "integer" } }, "required": [ "id", "slug", "title", "width", "height", "block_width", "block_height", "status" ], "type": "object" }, "GridWrite": { "additionalProperties": false, "properties": { "block_height": { "example": 10, "minimum": 1, "type": "integer" }, "block_width": { "example": 10, "minimum": 1, "type": "integer" }, "currency": { "example": "USD", "type": "string" }, "description": { "type": "string" }, "height": { "example": 1000, "minimum": 1, "type": "integer" }, "price_per_block": { "example": 1, "minimum": 0, "type": "number" }, "settings": { "additionalProperties": true, "type": "object" }, "slug": { "example": "main-grid", "type": "string" }, "status": { "enum": [ "active", "paused", "archived" ], "type": "string" }, "title": { "example": "Main Grid", "type": "string" }, "width": { "example": 1000, "minimum": 1, "type": "integer" } }, "type": "object" }, "MigrationRequest": { "additionalProperties": false, "properties": { "source_prefix": { "example": "wp_mds_", "pattern": "^[A-Za-z0-9_]*$", "type": "string" } }, "type": "object" }, "Order": { "additionalProperties": true, "properties": { "currency": { "type": "string" }, "id": { "type": "integer" }, "items": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": true, "type": "object" }, "placement_rect": { "$ref": "#/components/schemas/Rectangle" }, "status": { "type": "string" }, "subtotal": { "type": "number" }, "total": { "type": "number" }, "user_id": { "type": "integer" } }, "required": [ "id", "status" ], "type": "object" }, "OrderStatusUpdate": { "properties": { "status": { "enum": [ "reserved", "pending_payment", "paid", "cancelled", "failed", "refunded", "expired", "denied", "deleted" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "PackageWrite": { "additionalProperties": false, "properties": { "currency": { "example": "USD", "type": "string" }, "description": { "type": "string" }, "duration_days": { "example": 30, "minimum": 0, "type": "integer" }, "id": { "minimum": 1, "type": "integer" }, "is_default": { "type": "boolean" }, "max_orders": { "minimum": 0, "type": "integer" }, "metadata": { "additionalProperties": true, "type": "object" }, "price": { "example": 99, "minimum": 0, "type": "number" }, "status": { "enum": [ "active", "paused", "archived" ], "type": "string" }, "title": { "example": "30-day placement", "type": "string" } }, "type": "object" }, "Placement": { "additionalProperties": true, "properties": { "alt_text": { "type": "string" }, "attachment_id": { "type": "integer" }, "block_id": { "type": "integer" }, "fit_mode": { "enum": [ "cover", "contain" ], "type": "string" }, "grid_id": { "type": "integer" }, "height": { "type": "integer" }, "id": { "type": "integer" }, "link_url": { "format": "uri", "type": "string" }, "mask": { "items": { "$ref": "#/components/schemas/Rectangle" }, "type": "array" }, "popup_text": { "type": "string" }, "source": { "additionalProperties": true, "type": "object" }, "status": { "type": "string" }, "width": { "type": "integer" }, "x": { "type": "integer" }, "y": { "type": "integer" } }, "required": [ "id", "grid_id", "x", "y", "width", "height", "status" ], "type": "object" }, "PlacementCreate": { "additionalProperties": false, "properties": { "alt_text": { "type": "string" }, "attachment_id": { "minimum": 1, "type": "integer" }, "block_id": { "minimum": 1, "type": "integer" }, "fit_mode": { "enum": [ "cover", "contain" ], "type": "string" }, "height": { "minimum": 1, "type": "integer" }, "link_url": { "format": "uri", "type": "string" }, "order_id": { "minimum": 1, "type": "integer" }, "popup_text": { "type": "string" }, "sort_order": { "type": "integer" }, "status": { "enum": [ "pending", "active", "cancelled", "archived" ], "type": "string" }, "user_id": { "minimum": 1, "type": "integer" }, "width": { "minimum": 1, "type": "integer" }, "x": { "minimum": 0, "type": "integer" }, "y": { "minimum": 0, "type": "integer" } }, "required": [ "attachment_id" ], "type": "object" }, "PriceRuleWrite": { "additionalProperties": false, "properties": { "block_id_from": { "minimum": 0, "type": [ "integer", "null" ] }, "block_id_to": { "minimum": 0, "type": [ "integer", "null" ] }, "col_from": { "minimum": 0, "type": [ "integer", "null" ] }, "col_to": { "minimum": 0, "type": [ "integer", "null" ] }, "color": { "example": "#2563eb", "type": "string" }, "currency": { "example": "USD", "type": "string" }, "id": { "minimum": 1, "type": "integer" }, "metadata": { "additionalProperties": true, "type": "object" }, "price": { "example": 2.5, "minimum": 0, "type": "number" }, "row_from": { "minimum": 0, "type": [ "integer", "null" ] }, "row_to": { "minimum": 0, "type": [ "integer", "null" ] }, "status": { "enum": [ "active", "paused", "archived" ], "type": "string" } }, "type": "object" }, "Rectangle": { "properties": { "height": { "minimum": 1, "type": "integer" }, "width": { "minimum": 1, "type": "integer" }, "x": { "minimum": 0, "type": "integer" }, "y": { "minimum": 0, "type": "integer" } }, "required": [ "x", "y", "width", "height" ], "type": "object" }, "ReservationRequest": { "additionalProperties": false, "properties": { "blocks": { "items": { "$ref": "#/components/schemas/BlockCoordinate" }, "minItems": 1, "type": "array" }, "email": { "example": "buyer@example.com", "format": "email", "type": "string" }, "metadata": { "additionalProperties": true, "type": "object" }, "package_id": { "minimum": 0, "type": "integer" }, "subscription_plan_id": { "minimum": 0, "type": "integer" }, "user_id": { "minimum": 0, "type": "integer" } }, "required": [ "blocks" ], "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "in": "header", "name": "X-Million-Dollar-Script-API-Key", "type": "apiKey" }, "BearerAuth": { "scheme": "bearer", "type": "http" }, "ServiceSignatureV1": { "description": "HMAC-SHA256 request signature using the Million Dollar Script v1 service-signature contract.", "in": "header", "name": "X-MDS-Signature", "type": "apiKey" }, "WpCookieNonce": { "in": "header", "name": "X-WP-Nonce", "type": "apiKey" } } }, "info": { "description": "Static contract for the Million Dollar Script core API.", "title": "Million Dollar Script API", "version": "3.0.0", "x-generated-from": "MillionDollarScript\\V3\\Rest\\ApiGovernance" }, "openapi": "3.1.0", "paths": { "/api/audit-logs": { "get": { "operationId": "coreApiAuditLogsReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Read API audit logs.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-audit-logs-read", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" } }, "/api/discovery": { "get": { "operationId": "coreApiDiscoveryManageGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Read administrator API discovery metadata.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-discovery-manage", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" } }, "/api/keys": { "get": { "operationId": "coreApiKeysManageGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Manage API keys.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-keys-manage", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" }, "post": { "operationId": "coreApiKeysManagePost", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKeyCreate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Manage API keys.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-keys-manage", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" } }, "/api/keys/{id}": { "delete": { "operationId": "coreApiKeyRevokeDelete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Revoke an API key.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-key-revoke", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" } }, "/api/keys/{id}/rotate": { "post": { "operationId": "coreApiKeyRotatePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Rotate an API key.", "tags": [ "Api" ], "x-mds-endpoint-id": "core-api-key-rotate", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.api.manage", "x-mds-security-level": "wp_capability" } }, "/extensions": { "get": { "operationId": "coreExtensionsCatalogReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read extension catalog.", "tags": [ "Extensions" ], "x-mds-endpoint-id": "core-extensions-catalog-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.extension.read", "x-mds-security-level": "api_key_read" } }, "/extensions/capabilities": { "get": { "operationId": "coreExtensionCapabilitiesReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read extension capabilities.", "tags": [ "Extensions" ], "x-mds-endpoint-id": "core-extension-capabilities-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.extension.read", "x-mds-security-level": "api_key_read" } }, "/extensions/discovery": { "get": { "operationId": "coreDiscoveryReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read Million Dollar Script endpoint and extension discovery metadata.", "tags": [ "Extensions" ], "x-mds-endpoint-id": "core-discovery-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.extension.read", "x-mds-security-level": "api_key_read" } }, "/extensions/openapi": { "get": { "operationId": "coreOpenapiReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read the OpenAPI contract for Million Dollar Script and active extensions.", "tags": [ "Extensions" ], "x-mds-endpoint-id": "core-openapi-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.extension.read", "x-mds-security-level": "api_key_read" } }, "/extensions/setup": { "get": { "operationId": "coreExtensionSetupReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read setup extension selections.", "tags": [ "Extensions" ], "x-mds-endpoint-id": "core-extension-setup-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.extension.read", "x-mds-security-level": "api_key_read" } }, "/grids": { "get": { "operationId": "coreGridsReadGet", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Grid" }, "type": "array" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [], "summary": "List public grids.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grids-read", "x-mds-minimum-security-level": "public_read", "x-mds-scope": "core.grid.read", "x-mds-security-level": "public_read" }, "post": { "operationId": "coreGridsWritePost", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridWrite" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grid" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Create grids.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grids-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}": { "delete": { "operationId": "coreGridManageDelete", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grid" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update or archive grids.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grid-manage", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" }, "get": { "operationId": "coreGridReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grid" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [], "summary": "Read a public grid.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grid-read", "x-mds-minimum-security-level": "public_read", "x-mds-scope": "core.grid.read", "x-mds-security-level": "public_read" }, "patch": { "operationId": "coreGridManagePatch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridWrite" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grid" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update or archive grids.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grid-manage", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" }, "put": { "operationId": "coreGridManagePut", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GridWrite" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Grid" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update or archive grids.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-grid-manage", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/availability": { "post": { "operationId": "coreAvailabilityManagePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailabilityUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update grid availability regions.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-availability-manage", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/blocks": { "get": { "operationId": "coreBlocksReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Block" }, "type": "array" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [], "summary": "List grid blocks.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-blocks-read", "x-mds-minimum-security-level": "public_read", "x-mds-scope": "core.grid.read", "x-mds-security-level": "public_read" } }, "/grids/{id}/packages": { "get": { "operationId": "corePackagesReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "List grid packages.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-packages-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.grid.read", "x-mds-security-level": "api_key_read" }, "post": { "operationId": "corePackagesWritePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackageWrite" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Create or update grid packages.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-packages-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/placements": { "get": { "operationId": "corePlacementsReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Placement" }, "type": "array" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [], "summary": "List public placements.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-placements-read", "x-mds-minimum-security-level": "public_read", "x-mds-scope": "core.placement.read", "x-mds-security-level": "public_read" }, "post": { "operationId": "corePlacementsWritePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementCreate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Create placements.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-placements-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.placement.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/price-rules": { "get": { "operationId": "corePriceRulesReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "List grid price rules.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-price-rules-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.grid.read", "x-mds-security-level": "api_key_read" }, "post": { "operationId": "corePriceRulesWritePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceRuleWrite" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Create or update grid price rules.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-price-rules-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.grid.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/render": { "post": { "operationId": "coreRenderManagePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Submit render jobs.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-render-manage", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.render.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/render-preflight": { "get": { "operationId": "coreRenderPreflightReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read grid render preflight data.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-render-preflight-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.render.read", "x-mds-security-level": "api_key_read" }, "post": { "operationId": "coreRenderPreflightWritePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Run grid render preflight.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-render-preflight-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.render.write", "x-mds-security-level": "api_key_write" } }, "/grids/{id}/render-status": { "get": { "operationId": "coreRenderStatusReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read grid render status.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-render-status-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.render.read", "x-mds-security-level": "api_key_read" } }, "/grids/{id}/reservations": { "post": { "operationId": "coreReservationsWritePost", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservationRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Create block reservations.", "tags": [ "Grids" ], "x-mds-endpoint-id": "core-reservations-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.order.write", "x-mds-security-level": "api_key_write" } }, "/migration/dry-run": { "post": { "operationId": "coreMigrationDryRunPost", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Run a Million Dollar Script 2 migration dry run.", "tags": [ "Migration" ], "x-mds-endpoint-id": "core-migration-dry-run", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.migration.write", "x-mds-security-level": "wp_capability" } }, "/migration/execute": { "post": { "operationId": "coreMigrationExecutePost", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MigrationRequest" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "WpCookieNonce": [] } ], "summary": "Import reviewed Million Dollar Script 2 data.", "tags": [ "Migration" ], "x-mds-endpoint-id": "core-migration-execute", "x-mds-minimum-security-level": "wp_capability", "x-mds-scope": "core.migration.write", "x-mds-security-level": "wp_capability" } }, "/orders": { "get": { "operationId": "coreOrdersManageGet", "parameters": [ { "description": "Number of recent orders to return.", "in": "query", "name": "per_page", "required": false, "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Order" }, "type": "array" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read orders.", "tags": [ "Orders" ], "x-mds-endpoint-id": "core-orders-manage", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.order.read", "x-mds-security-level": "api_key_read" } }, "/orders/{id}": { "get": { "operationId": "coreOrderReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read one order.", "tags": [ "Orders" ], "x-mds-endpoint-id": "core-order-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.order.read", "x-mds-security-level": "api_key_read" }, "patch": { "operationId": "coreOrdersWritePatch", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update order state.", "tags": [ "Orders" ], "x-mds-endpoint-id": "core-orders-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.order.write", "x-mds-security-level": "api_key_write" }, "put": { "operationId": "coreOrdersWritePut", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderStatusUpdate" } } }, "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Update order state.", "tags": [ "Orders" ], "x-mds-endpoint-id": "core-orders-write", "x-mds-minimum-security-level": "api_key_write", "x-mds-scope": "core.order.write", "x-mds-security-level": "api_key_write" } }, "/orders/{id}/items": { "get": { "operationId": "coreOrderItemsReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read order items.", "tags": [ "Orders" ], "x-mds-endpoint-id": "core-order-items-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.order.read", "x-mds-security-level": "api_key_read" } }, "/render-jobs/{id}": { "get": { "operationId": "coreRenderJobsReadGet", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "type": "object" } } }, "description": "Successful response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The request is invalid." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Authentication is required." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The authenticated actor is not allowed to use this endpoint." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The requested resource was not found." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "The API key rate limit was exceeded." } }, "security": [ { "ApiKeyAuth": [] }, { "BearerAuth": [] } ], "summary": "Read render job status.", "tags": [ "Render Jobs" ], "x-mds-endpoint-id": "core-render-jobs-read", "x-mds-minimum-security-level": "api_key_read", "x-mds-scope": "core.render.read", "x-mds-security-level": "api_key_read" } } }, "servers": [ { "description": "The WordPress site where Million Dollar Script is installed.", "url": "https://{site}/wp-json/million-dollar-script/v1", "variables": { "site": { "default": "example.com" } } } ], "x-mds": { "extension_manifests": [], "namespace": "million-dollar-script/v1", "security_levels": [ "public_read", "public_write_nonce", "api_key_read", "api_key_write", "signed_manage_token", "service_signature", "wp_capability", "disabled" ], "service_signature": { "algorithm": "HMAC-SHA256", "canonical_fields": [ "version", "service_id", "method", "route", "timestamp", "nonce", "body_sha256", "idempotency_key" ], "canonical_route": "/million-dollar-script/v1/...", "clock_skew_seconds": 300, "required_headers": [ "X-MDS-Service-Id", "X-MDS-Signature-Version", "X-MDS-Timestamp", "X-MDS-Nonce", "X-MDS-Content-SHA256", "X-MDS-Signature" ], "version": "v1" } } }