{ "openapi": "3.0.3", "info": { "title": "Canchasers - A site for Barrel Racers REST API", "description": "Canchasers - A site for Barrel Racers and Pole bending competitions with new articles and help with horse training.", "version": "7.1.4" }, "servers": [ { "url": "https://canchasers.com/", "description": "Canchasers - A site for Barrel Racers" } ], "paths": { "/ajaco/v1": { "get": { "summary": "GET /ajaco/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "ajaco/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/ajaco/v1/external": { "get": { "summary": "GET /ajaco/v1/external", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "refresh", "in": "query", "schema": { "type": "boolean" } } ] } }, "/ajaco/v1/fix": { "post": { "summary": "POST /ajaco/v1/fix", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "check": { "type": "string" } }, "required": [ "check" ] } } } } } }, "/ajaco/v1/health": { "get": { "summary": "GET /ajaco/v1/health", "responses": { "200": { "description": "Successful response" } } } }, "/ajaco/v1/llms/preview": { "post": { "summary": "POST /ajaco/v1/llms/preview", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "description": "Unsaved llms.txt curation config to preview. Omit to preview the saved config." } } } } } } } }, "/ajaco/v1/scan": { "get": { "summary": "GET /ajaco/v1/scan", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /ajaco/v1/scan", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "string" } } } } } } } } }, "/ajaco/v1/scan/check": { "post": { "summary": "POST /ajaco/v1/scan/check", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "check": { "type": "string" } }, "required": [ "check" ] } } } } } }, "/batch/v1": { "post": { "summary": "POST /batch/v1", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validation": { "type": "string", "default": "normal", "enum": [ "require-all-validate", "normal" ] }, "requests": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "default": "POST" }, "path": { "type": "string", "required": true }, "body": { "type": "object", "properties": [], "additionalProperties": true }, "headers": { "type": "object", "properties": [], "additionalProperties": { "type": [ "string", "array" ], "items": { "type": "string" } } } } } } }, "required": [ "requests" ] } } } } } }, "/cky/v1": { "get": { "summary": "GET /cky/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "cky/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/cky/v1/uninstall-feedback": { "post": { "summary": "POST /cky/v1/uninstall-feedback", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1": { "get": { "summary": "GET /code-snippets/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "code-snippets/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/code-snippets/v1/cloud/snippets": { "get": { "summary": "GET /code-snippets/v1/cloud/snippets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Search query." }, { "name": "searchByCodevault", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Treat the search query as the name of a CodeVault instead of a search term." }, { "name": "searchMethod", "in": "query", "schema": { "type": "string", "default": "term", "enum": [ "term", "codevault", "ai" ] }, "description": "Optional search method. Set to "ai" to match snippets by natural-language intent." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "category", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by category ID." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by language/type ID." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by status ID." } ] } }, "/code-snippets/v1/cloud/snippets/featured": { "get": { "summary": "GET /code-snippets/v1/cloud/snippets/featured", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by category ID." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by language/type ID." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by status ID." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." } ] } }, "/code-snippets/v1/cloud/snippets/{id}/download": { "post": { "summary": "POST /code-snippets/v1/cloud/snippets/{id}/download", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "number" }, "description": "Cloud snippet ID." } ] } }, "/code-snippets/v1/feedback": { "post": { "summary": "POST /code-snippets/v1/feedback", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/feedback/search": { "get": { "summary": "GET /code-snippets/v1/feedback/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Report title to look for." } ] } }, "/code-snippets/v1/import/file-upload/import": { "post": { "summary": "POST /code-snippets/v1/import/file-upload/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "snippets": { "type": "array", "items": { "type": "string" }, "description": "Snippet data to import" }, "duplicate_action": { "type": "string", "default": "ignore", "enum": [ "ignore", "replace", "skip" ], "description": "Action to take when duplicate snippets are found" }, "network": { "type": "boolean", "default": false, "description": "Whether to import to network table" } }, "required": [ "snippets" ] } } } } } }, "/code-snippets/v1/import/file-upload/parse": { "post": { "summary": "POST /code-snippets/v1/import/file-upload/parse", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins": { "get": { "summary": "GET /code-snippets/v1/import/plugins", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/header-footer-code-manager": { "get": { "summary": "GET /code-snippets/v1/import/plugins/header-footer-code-manager", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/header-footer-code-manager/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/header-footer-code-manager/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/import/plugins/insert-headers-and-footers": { "get": { "summary": "GET /code-snippets/v1/import/plugins/insert-headers-and-footers", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/insert-headers-and-footers/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/insert-headers-and-footers/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/import/plugins/insert-php-code-snippet": { "get": { "summary": "GET /code-snippets/v1/import/plugins/insert-php-code-snippet", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/insert-php-code-snippet/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/insert-php-code-snippet/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/preferences/demos-seen": { "get": { "summary": "GET /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } } }, "/code-snippets/v1/preferences/snippet-view": { "get": { "summary": "GET /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } } }, "/code-snippets/v1/preferences/stats-chart-views": { "get": { "summary": "GET /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } } }, "/code-snippets/v1/recently-active": { "get": { "summary": "GET /code-snippets/v1/recently-active", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Fetch the recent list for network-wide snippets instead of site-wide." } ] }, "delete": { "summary": "DELETE /code-snippets/v1/recently-active", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Clear the recent list for network-wide snippets instead of site-wide." } ] } }, "/code-snippets/v1/search": { "get": { "summary": "GET /code-snippets/v1/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Text to search for." }, { "name": "sources", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "snippets", "settings", "stats", "welcome", "docs", "community" ] }, "default": [ "snippets", "settings", "stats", "welcome", "docs", "community" ] }, "description": "Sources to search. Defaults to every source." }, { "name": "fields", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "code" ] }, "default": [ "title", "description", "code" ] }, "description": "Fields to match the search text against. Defaults to every field." }, { "name": "method", "in": "query", "schema": { "type": "string", "default": "term", "enum": [ "term", "ai" ] }, "description": "How to search the cloud: by keyword, or with AI." }, { "name": "per_source", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Largest number of results to return for each source." }, { "name": "excerpts", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to shorten long descriptions to an excerpt around the match." }, { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Search network-wide snippets instead of site-wide." } ] } }, "/code-snippets/v1/snippets": { "get": { "summary": "GET /code-snippets/v1/snippets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "all", "enum": [ "all", "active", "inactive" ] }, "description": "Filter snippets by activation status." }, { "name": "exclude_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": [] }, "description": "List of snippet types to exclude from the response." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "enum": [ "id", "name", "display_name" ] }, "description": "Sort collection by object attribute." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Sort direction." } ] }, "post": { "summary": "POST /code-snippets/v1/snippets", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } } }, "/code-snippets/v1/snippets/schema": { "get": { "summary": "GET /code-snippets/v1/snippets/schema", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/snippets/{id}": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "delete": { "summary": "DELETE /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/activate": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/deactivate": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/export": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}/export", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/export-code": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}/export-code", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/restore": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contact-form-7/v1": { "get": { "summary": "GET /contact-form-7/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "contact-form-7/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/contact-form-7/v1/contact-forms": { "get": { "summary": "GET /contact-form-7/v1/contact-forms", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /contact-form-7/v1/contact-forms", "responses": { "200": { "description": "Successful response" } } } }, "/contact-form-7/v1/contact-forms/{id}": { "get": { "summary": "GET /contact-form-7/v1/contact-forms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /contact-form-7/v1/contact-forms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /contact-form-7/v1/contact-forms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /contact-form-7/v1/contact-forms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /contact-form-7/v1/contact-forms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contact-form-7/v1/contact-forms/{id}/feedback": { "post": { "summary": "POST /contact-form-7/v1/contact-forms/{id}/feedback", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contact-form-7/v1/contact-forms/{id}/feedback/schema": { "get": { "summary": "GET /contact-form-7/v1/contact-forms/{id}/feedback/schema", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/contact-form-7/v1/contact-forms/{id}/refill": { "get": { "summary": "GET /contact-form-7/v1/contact-forms/{id}/refill", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/cookieyes/v1": { "get": { "summary": "GET /cookieyes/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "cookieyes/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/cookieyes/v1/fetch_results": { "post": { "summary": "POST /cookieyes/v1/fetch_results", "responses": { "200": { "description": "Successful response" } } } }, "/oembed/1.0": { "get": { "summary": "GET /oembed/1.0", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "oembed/1.0" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/oembed/1.0/embed": { "get": { "summary": "GET /oembed/1.0/embed", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL of the resource for which to fetch oEmbed data." }, { "name": "format", "in": "query", "schema": { "default": "json" } }, { "name": "maxwidth", "in": "query", "schema": { "default": 600 } } ] } }, "/oembed/1.0/proxy": { "get": { "summary": "GET /oembed/1.0/proxy", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL of the resource for which to fetch oEmbed data." }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "json", "enum": [ "json", "xml" ] }, "description": "The oEmbed format to use." }, { "name": "maxwidth", "in": "query", "schema": { "type": "integer", "default": 600 }, "description": "The maximum width of the embed frame in pixels." }, { "name": "maxheight", "in": "query", "schema": { "type": "integer" }, "description": "The maximum height of the embed frame in pixels." }, { "name": "discover", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to perform an oEmbed discovery request for unsanctioned providers." } ] } }, "/simple-sitemap/v1": { "get": { "summary": "GET /simple-sitemap/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "simple-sitemap/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/simple-sitemap/v1/child-pages-preview": { "post": { "summary": "POST /simple-sitemap/v1/child-pages-preview", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "default": [] } } } } } } } }, "/simple-sitemap/v1/hierarchical-post-types": { "get": { "summary": "GET /simple-sitemap/v1/hierarchical-post-types", "responses": { "200": { "description": "Successful response" } } } }, "/simple-sitemap/v1/navigation-menu-preview": { "post": { "summary": "POST /simple-sitemap/v1/navigation-menu-preview", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "default": [] } } } } } } } }, "/simple-sitemap/v1/navigation-menus": { "get": { "summary": "GET /simple-sitemap/v1/navigation-menus", "responses": { "200": { "description": "Successful response" } } } }, "/simple-sitemap/v1/post-type-taxonomies/{type}": { "get": { "summary": "GET /simple-sitemap/v1/post-type-taxonomies/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/simple-sitemap/v1/post-types": { "get": { "summary": "GET /simple-sitemap/v1/post-types", "responses": { "200": { "description": "Successful response" } } } }, "/simple-sitemap/v1/taxonomies": { "get": { "summary": "GET /simple-sitemap/v1/taxonomies", "responses": { "200": { "description": "Successful response" } } } }, "/simple-sitemap/v1/taxonomy-terms-preview": { "post": { "summary": "POST /simple-sitemap/v1/taxonomy-terms-preview", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "attributes": { "type": "object", "default": [] } } } } } } } }, "/wordfence-login-security/v1": { "get": { "summary": "GET /wordfence-login-security/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wordfence-login-security/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wordfence-login-security/v1/internal/passkey-login/begin": { "post": { "summary": "POST /wordfence-login-security/v1/internal/passkey-login/begin", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence-login-security/v1/internal/passkey-login/finish": { "post": { "summary": "POST /wordfence-login-security/v1/internal/passkey-login/finish", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1": { "get": { "summary": "GET /wordfence/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wordfence/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wordfence/v1/authenticate": { "get": { "summary": "GET /wordfence/v1/authenticate", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /wordfence/v1/authenticate", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1/config": { "get": { "summary": "GET /wordfence/v1/config", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /wordfence/v1/config", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /wordfence/v1/config", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /wordfence/v1/config", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1/disconnect": { "post": { "summary": "POST /wordfence/v1/disconnect", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /wordfence/v1/disconnect", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /wordfence/v1/disconnect", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1/scan": { "post": { "summary": "POST /wordfence/v1/scan", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /wordfence/v1/scan", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1/scan/issue": { "post": { "summary": "POST /wordfence/v1/scan/issue", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /wordfence/v1/scan/issue", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /wordfence/v1/scan/issue", "responses": { "200": { "description": "Successful response" } } } }, "/wordfence/v1/scan/issues": { "get": { "summary": "GET /wordfence/v1/scan/issues", "responses": { "200": { "description": "Successful response" } } } }, "/wp-abilities/v1": { "get": { "summary": "GET /wp-abilities/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-abilities/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-abilities/v1/abilities": { "get": { "summary": "GET /wp-abilities/v1/abilities", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Maximum number of items to be returned in result set." }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Limit results to abilities in specific ability category." }, { "name": "namespace", "in": "query", "schema": { "type": "string" }, "description": "Limit results to abilities in a specific namespace." }, { "name": "meta", "in": "query", "schema": { "type": "object" }, "description": "Limit results to abilities matching all of the given meta fields." } ] } }, "/wp-abilities/v1/abilities/{name}": { "get": { "summary": "GET /wp-abilities/v1/abilities/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ] } }, "/wp-abilities/v1/abilities/{name}/run": { "get": { "summary": "GET /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." }, { "name": "input", "in": "query", "schema": { "type": "integer" }, "description": "Input parameters for the ability execution." } ] }, "post": { "summary": "POST /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "put": { "summary": "PUT /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "patch": { "summary": "PATCH /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "delete": { "summary": "DELETE /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." }, { "name": "input", "in": "query", "schema": { "type": "integer" }, "description": "Input parameters for the ability execution." } ] } }, "/wp-abilities/v1/categories": { "get": { "summary": "GET /wp-abilities/v1/categories", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Maximum number of items to be returned in result set." } ] } }, "/wp-abilities/v1/categories/{slug}": { "get": { "summary": "GET /wp-abilities/v1/categories/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability category." } ] } }, "/wp-block-editor/v1": { "get": { "summary": "GET /wp-block-editor/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-block-editor/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-block-editor/v1/export": { "get": { "summary": "GET /wp-block-editor/v1/export", "responses": { "200": { "description": "Successful response" } } } }, "/wp-block-editor/v1/navigation-fallback": { "get": { "summary": "GET /wp-block-editor/v1/navigation-fallback", "responses": { "200": { "description": "Successful response" } } } }, "/wp-block-editor/v1/url-details": { "get": { "summary": "GET /wp-block-editor/v1/url-details", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL to process." } ] } }, "/wp-mail-smtp/setup-wizard/v1": { "get": { "summary": "GET /wp-mail-smtp/setup-wizard/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-mail-smtp/setup-wizard/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-mail-smtp/setup-wizard/v1/check-mailer-configuration": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/check-mailer-configuration", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/get-connected-data": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/get-connected-data", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/get-oauth-url": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/get-oauth-url", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/health": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/health", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/hydrate": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/hydrate", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/import-settings": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/import-settings", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/mailer-preflight": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/mailer-preflight", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/remove-oauth-connection": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/remove-oauth-connection", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/sendlayer-disconnect": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/sendlayer-disconnect", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/settings": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/settings", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/update": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/update", "responses": { "200": { "description": "Successful response" } } } }, "/wp-mail-smtp/setup-wizard/v1/upgrade-plugin": { "post": { "summary": "POST /wp-mail-smtp/setup-wizard/v1/upgrade-plugin", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1": { "get": { "summary": "GET /wp-site-health/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-site-health/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-site-health/v1/directory-sizes": { "get": { "summary": "GET /wp-site-health/v1/directory-sizes", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/authorization-header": { "get": { "summary": "GET /wp-site-health/v1/tests/authorization-header", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/background-updates": { "get": { "summary": "GET /wp-site-health/v1/tests/background-updates", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/dotorg-communication": { "get": { "summary": "GET /wp-site-health/v1/tests/dotorg-communication", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/https-status": { "get": { "summary": "GET /wp-site-health/v1/tests/https-status", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/loopback-requests": { "get": { "summary": "GET /wp-site-health/v1/tests/loopback-requests", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/page-cache": { "get": { "summary": "GET /wp-site-health/v1/tests/page-cache", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2": { "get": { "summary": "GET /wp/v2", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp/v2" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp/v2/block-directory/search": { "get": { "summary": "GET /wp/v2/block-directory/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "term", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Limit result set to blocks matching the search term." } ] } }, "/wp/v2/block-patterns/categories": { "get": { "summary": "GET /wp/v2/block-patterns/categories", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2/block-patterns/patterns": { "get": { "summary": "GET /wp/v2/block-patterns/patterns", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2/block-renderer/{name}": { "get": { "summary": "GET /wp/v2/block-renderer/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique registered name for the block." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "attributes", "in": "query", "schema": { "type": "object", "default": [] }, "description": "Attributes for the block." }, { "name": "post_id", "in": "query", "schema": { "type": "integer" }, "description": "ID of the post context." } ] }, "post": { "summary": "POST /wp/v2/block-renderer/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique registered name for the block." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "attributes": { "type": "object", "default": [], "description": "Attributes for the block." }, "post_id": { "type": "integer", "description": "ID of the post context." } } } } } } } }, "/wp/v2/block-types": { "get": { "summary": "GET /wp/v2/block-types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "namespace", "in": "query", "schema": { "type": "string" }, "description": "Block namespace." } ] } }, "/wp/v2/block-types/{namespace}": { "get": { "summary": "GET /wp/v2/block-types/{namespace}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block namespace." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/block-types/{namespace}/{name}": { "get": { "summary": "GET /wp/v2/block-types/{namespace}/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block namespace." }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block name." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/blocks": { "get": { "summary": "GET /wp/v2/blocks", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wp_pattern_category", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy." }, { "name": "wp_pattern_category_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy." } ] }, "post": { "summary": "POST /wp/v2/blocks", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } } }, "/wp/v2/blocks/{id}": { "get": { "summary": "GET /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "put": { "summary": "PUT /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/blocks/{id}/autosaves": { "get": { "summary": "GET /wp/v2/blocks/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/blocks/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } } }, "/wp/v2/blocks/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/blocks/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/blocks/{parent}/revisions": { "get": { "summary": "GET /wp/v2/blocks/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/blocks/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/blocks/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/blocks/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/categories": { "get": { "summary": "GET /wp/v2/categories", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/categories", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/categories/{id}": { "get": { "summary": "GET /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/comments": { "get": { "summary": "GET /wp/v2/comments", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to comments published after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Limit result set to comments assigned to specific user IDs. Requires authorization." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorization." }, { "name": "author_email", "in": "query", "schema": { "type": "string", "format": "email" }, "description": "Limit result set to that from a specific author email. Requires authorization." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to comments published before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date_gmt", "enum": [ "date", "date_gmt", "id", "include", "post", "parent", "type" ] }, "description": "Sort collection by comment attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to comments of specific parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific parent IDs." }, { "name": "post", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to comments assigned to specific post IDs." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "approve" }, "description": "Limit result set to comments assigned a specific status. Requires authorization." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "comment" }, "description": "Limit result set to comments assigned a specific type. Requires authorization." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/comments", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "default": 0, "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "default": 0, "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/comments/{id}": { "get": { "summary": "GET /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the parent post of the comment (if the post is password protected)." } ] }, "post": { "summary": "POST /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the parent post of the comment (if the post is password protected)." } ] } }, "/wp/v2/font-collections": { "get": { "summary": "GET /wp/v2/font-collections", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." } ] } }, "/wp/v2/font-collections/{slug}": { "get": { "summary": "GET /wp/v2/font-collections/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/font-families": { "get": { "summary": "GET /wp/v2/font-families", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "id", "enum": [ "id", "include" ] }, "description": "Sort collection by post attribute." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/font-families", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } } }, "/wp/v2/font-families/{font_family_id}/font-faces": { "get": { "summary": "GET /wp/v2/font-families/{font_family_id}/font-faces", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "id", "enum": [ "id", "include" ] }, "description": "Sort collection by post attribute." } ] }, "post": { "summary": "POST /wp/v2/font-families/{font_family_id}/font-faces", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_face_settings": { "type": "string", "description": "font-face declaration in theme.json format, encoded as a string." } }, "required": [ "font_face_settings" ] } } } } } }, "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { "get": { "summary": "GET /wp/v2/font-families/{font_family_id}/font-faces/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the font face." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the font face." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/font-families/{id}": { "get": { "summary": "GET /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "put": { "summary": "PUT /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "patch": { "summary": "PATCH /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "delete": { "summary": "DELETE /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/global-styles/themes/{stylesheet}": { "get": { "summary": "GET /wp/v2/global-styles/themes/{stylesheet}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme identifier" } ] } }, "/wp/v2/global-styles/themes/{stylesheet}/variations": { "get": { "summary": "GET /wp/v2/global-styles/themes/{stylesheet}/variations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme identifier" } ] } }, "/wp/v2/global-styles/{id}": { "get": { "summary": "GET /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "ID of global styles config." } ] }, "post": { "summary": "POST /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } }, "put": { "summary": "PUT /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } } }, "/wp/v2/global-styles/{parent}/revisions": { "get": { "summary": "GET /wp/v2/global-styles/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." } ] } }, "/wp/v2/global-styles/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/global-styles/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the global styles revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the global styles revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/icon-collections": { "get": { "summary": "GET /wp/v2/icon-collections", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] } }, "/wp/v2/icon-collections/{slug}": { "get": { "summary": "GET /wp/v2/icon-collections/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Icon collection slug." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/icons": { "get": { "summary": "GET /wp/v2/icons", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "collection", "in": "query", "schema": { "type": "string" }, "description": "Limit results to icons belonging to the given collection slug." } ] } }, "/wp/v2/icons/{collection}": { "get": { "summary": "GET /wp/v2/icons/{collection}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Limit results to icons belonging to the given collection slug." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] } }, "/wp/v2/icons/{name}": { "get": { "summary": "GET /wp/v2/icons/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Icon name." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/media": { "get": { "summary": "GET /wp/v2/media", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "inherit", "private", "trash" ], "type": "string" }, "default": "inherit" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "media_type", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "image", "video", "text", "application", "audio" ] } }, "description": "Limit result set to attachments of a particular media type or media types." }, { "name": "mime_type", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to attachments of a particular MIME type or MIME types." } ] }, "post": { "summary": "POST /wp/v2/media", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." }, "generate_sub_sizes": { "type": "boolean", "default": true, "description": "Whether to generate image sub sizes." }, "convert_format": { "type": "boolean", "default": true, "description": "Whether to convert image formats." }, "url": { "type": "string", "format": "uri", "description": "URL of an external image to sideload into the media library, instead of uploading a file." } } } } } } } }, "/wp/v2/media/{id}": { "get": { "summary": "GET /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "put": { "summary": "PUT /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/media/{id}/edit": { "post": { "summary": "POST /wp/v2/media/{id}/edit", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "src": { "type": "string", "format": "uri", "description": "URL to the edited image file." }, "modifiers": { "type": "array", "items": { "description": "Image edit.", "type": "object", "required": [ "type", "args" ], "oneOf": [ { "title": "Flip", "properties": { "type": { "description": "Flip type.", "type": "string", "enum": [ "flip" ] }, "args": { "description": "Flip arguments.", "type": "object", "required": [ "flip" ], "properties": { "flip": { "description": "Flip direction.", "type": "object", "required": [ "horizontal", "vertical" ], "properties": { "horizontal": { "description": "Whether to flip in the horizontal direction.", "type": "boolean" }, "vertical": { "description": "Whether to flip in the vertical direction.", "type": "boolean" } } } } } } }, { "title": "Rotation", "properties": { "type": { "description": "Rotation type.", "type": "string", "enum": [ "rotate" ] }, "args": { "description": "Rotation arguments.", "type": "object", "required": [ "angle" ], "properties": { "angle": { "description": "Angle to rotate clockwise in degrees.", "type": "number" } } } } }, { "title": "Crop", "properties": { "type": { "description": "Crop type.", "type": "string", "enum": [ "crop" ] }, "args": { "description": "Crop arguments.", "type": "object", "required": [ "left", "top", "width", "height" ], "properties": { "left": { "description": "Horizontal position from the left to begin the crop as a percentage of the image width.", "type": "number" }, "top": { "description": "Vertical position from the top to begin the crop as a percentage of the image height.", "type": "number" }, "width": { "description": "Width of the crop as a percentage of the image width.", "type": "number" }, "height": { "description": "Height of the crop as a percentage of the image height.", "type": "number" } } } } } ] }, "description": "Array of image edits." }, "rotation": { "type": "integer", "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: Use `modifiers` instead." }, "x": { "type": "number", "description": "As a percentage of the image, the x position to start the crop from. DEPRECATED: Use `modifiers` instead." }, "y": { "type": "number", "description": "As a percentage of the image, the y position to start the crop from. DEPRECATED: Use `modifiers` instead." }, "width": { "type": "number", "description": "As a percentage of the image, the width to crop the image to. DEPRECATED: Use `modifiers` instead." }, "height": { "type": "number", "description": "As a percentage of the image, the height to crop the image to. DEPRECATED: Use `modifiers` instead." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "title": { "type": "object", "description": "The title for the post." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." } }, "required": [ "src" ] } } } } } }, "/wp/v2/media/{id}/finalize": { "post": { "summary": "POST /wp/v2/media/{id}/finalize", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sub_sizes": { "type": "array", "items": { "type": "object", "properties": { "image_size": { "description": "Size name, or an array of size names when a single file is registered under multiple sizes with matching dimensions.", "type": [ "string", "array" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "minLength": 1, "required": true }, "width": { "type": "integer", "minimum": 1 }, "height": { "type": "integer", "minimum": 1 }, "file": { "type": "string", "minLength": 1 }, "mime_type": { "type": "string", "pattern": "^image/.*" }, "filesize": { "type": "integer", "minimum": 1 }, "original_image": { "type": "string", "minLength": 1 } } }, "default": [], "description": "Array of sub-size metadata collected from sideload responses." } } } } } } } }, "/wp/v2/media/{id}/post-process": { "post": { "summary": "POST /wp/v2/media/{id}/post-process", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create-image-subsizes" ] } }, "required": [ "action" ] } } } } } }, "/wp/v2/media/{id}/sideload": { "post": { "summary": "POST /wp/v2/media/{id}/sideload", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "image_size": { "type": "string", "description": "Image size. Can be a single size name or an array of size names to register the same file under multiple sizes." }, "convert_format": { "type": "boolean", "default": true, "description": "Whether to convert image formats." } }, "required": [ "image_size" ] } } } } } }, "/wp/v2/menu-items": { "get": { "summary": "GET /wp/v2/menu-items", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "menu_order", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by object attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "menus", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the menus taxonomy." }, { "name": "menus_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the menus taxonomy." }, { "name": "menu_order", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." } ] }, "post": { "summary": "POST /wp/v2/menu-items", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "default": "custom", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "default": 0, "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "default": 1, "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "default": 0, "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/menu-items/{id}": { "get": { "summary": "GET /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/menu-items/{id}/autosaves": { "get": { "summary": "GET /wp/v2/menu-items/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menu-items/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/menu-items/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/menu-items/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menu-locations": { "get": { "summary": "GET /wp/v2/menu-locations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menu-locations/{location}": { "get": { "summary": "GET /wp/v2/menu-locations/{location}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the menu location." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menus": { "get": { "summary": "GET /wp/v2/menus", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/menus", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } }, "required": [ "name" ] } } } } } }, "/wp/v2/menus/{id}": { "get": { "summary": "GET /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "put": { "summary": "PUT /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/navigation": { "get": { "summary": "GET /wp/v2/navigation", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/navigation", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/navigation/{id}": { "get": { "summary": "GET /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/navigation/{id}/autosaves": { "get": { "summary": "GET /wp/v2/navigation/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/navigation/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/navigation/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/navigation/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/navigation/{parent}/revisions": { "get": { "summary": "GET /wp/v2/navigation/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/navigation/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/navigation/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/navigation/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/pages": { "get": { "summary": "GET /wp/v2/pages", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "menu_order", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by post attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/pages", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/pages/{id}": { "get": { "summary": "GET /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/pages/{id}/autosaves": { "get": { "summary": "GET /wp/v2/pages/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/pages/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/pages/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/pages/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/pages/{parent}/revisions": { "get": { "summary": "GET /wp/v2/pages/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/pages/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/pages/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/pages/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/pattern-directory/patterns": { "get": { "summary": "GET /wp/v2/pattern-directory/patterns", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "category", "in": "query", "schema": { "type": "integer" }, "description": "Limit results to those matching a category ID." }, { "name": "keyword", "in": "query", "schema": { "type": "integer" }, "description": "Limit results to those matching a keyword ID." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit results to those matching a pattern (slug)." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "favorite_count" ] }, "description": "Sort collection by post attribute." } ] } }, "/wp/v2/plugins": { "get": { "summary": "GET /wp/v2/plugins", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "inactive", "active" ] } }, "description": "Limits results to plugins with the given status." } ] }, "post": { "summary": "POST /wp/v2/plugins", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "WordPress.org plugin directory slug." }, "status": { "type": "string", "default": "inactive", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } }, "required": [ "slug" ] } } } } } }, "/wp/v2/plugins/{plugin}": { "get": { "summary": "GET /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "put": { "summary": "PUT /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/posts": { "get": { "summary": "GET /wp/v2/posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "categories", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the categories taxonomy." }, { "name": "categories_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy." }, { "name": "tags", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the tags taxonomy." }, { "name": "tags_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy." }, { "name": "sticky", "in": "query", "schema": { "type": "boolean" }, "description": "Limit result set to items that are sticky." }, { "name": "ignore_sticky", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to ignore sticky posts or not." }, { "name": "format", "in": "query", "schema": { "type": "array", "items": { "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "type": "string" } }, "description": "Limit result set to items assigned one or more given formats." } ] }, "post": { "summary": "POST /wp/v2/posts", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } } }, "/wp/v2/posts/{id}": { "get": { "summary": "GET /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "put": { "summary": "PUT /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/posts/{id}/autosaves": { "get": { "summary": "GET /wp/v2/posts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/posts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } } }, "/wp/v2/posts/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/posts/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/posts/{parent}/revisions": { "get": { "summary": "GET /wp/v2/posts/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/posts/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/posts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/posts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/search": { "get": { "summary": "GET /wp/v2/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "post", "enum": [ "post", "term", "post-format" ] }, "description": "Limit results to items of an object type." }, { "name": "subtype", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post", "page", "category", "post_tag", "any" ], "type": "string" }, "default": "any" }, "description": "Limit results to items of one or more object subtypes." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." } ] } }, "/wp/v2/settings": { "get": { "summary": "GET /wp/v2/settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." } } } } } } }, "put": { "summary": "PUT /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." } } } } } } } }, "/wp/v2/sidebars": { "get": { "summary": "GET /wp/v2/sidebars", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/sidebars/{id}": { "get": { "summary": "GET /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a registered sidebar" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } }, "put": { "summary": "PUT /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } } }, "/wp/v2/statuses": { "get": { "summary": "GET /wp/v2/statuses", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/statuses/{status}": { "get": { "summary": "GET /wp/v2/statuses/{status}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the status." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/tags": { "get": { "summary": "GET /wp/v2/tags", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/tags", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/tags/{id}": { "get": { "summary": "GET /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/taxonomies": { "get": { "summary": "GET /wp/v2/taxonomies", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Limit results to taxonomies associated with a specific post type." } ] } }, "/wp/v2/taxonomies/{taxonomy}": { "get": { "summary": "GET /wp/v2/taxonomies/{taxonomy}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "taxonomy", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the taxonomy." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/template-parts": { "get": { "summary": "GET /wp/v2/template-parts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "in": "query", "schema": { "type": "integer" }, "description": "Limit to the specified post id." }, { "name": "area", "in": "query", "schema": { "type": "string" }, "description": "Limit to the specified template part area." }, { "name": "post_type", "in": "query", "schema": { "type": "string" }, "description": "Post type to get the templates for." } ] }, "post": { "summary": "POST /wp/v2/template-parts", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "default": "", "description": "Content of template." }, "title": { "type": "object", "default": "", "description": "Title of template." }, "description": { "type": "string", "default": "", "description": "Description of template." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } }, "required": [ "slug" ] } } } } } }, "/wp/v2/template-parts/lookup": { "get": { "summary": "GET /wp/v2/template-parts/lookup", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "in": "query", "schema": { "type": "boolean" }, "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "in": "query", "schema": { "type": "string" }, "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`" } ] } }, "/wp/v2/template-parts/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "put": { "summary": "PUT /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "patch": { "summary": "PATCH /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "delete": { "summary": "DELETE /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/template-parts/{id}/autosaves": { "get": { "summary": "GET /wp/v2/template-parts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/template-parts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } } }, "/wp/v2/template-parts/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/template-parts/{parent}/revisions": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/template-parts/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/template-parts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/templates": { "get": { "summary": "GET /wp/v2/templates", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "in": "query", "schema": { "type": "integer" }, "description": "Limit to the specified post id." }, { "name": "area", "in": "query", "schema": { "type": "string" }, "description": "Limit to the specified template part area." }, { "name": "post_type", "in": "query", "schema": { "type": "string" }, "description": "Post type to get the templates for." } ] }, "post": { "summary": "POST /wp/v2/templates", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "default": "", "description": "Content of template." }, "title": { "type": "object", "default": "", "description": "Title of template." }, "description": { "type": "string", "default": "", "description": "Description of template." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } }, "required": [ "slug" ] } } } } } }, "/wp/v2/templates/lookup": { "get": { "summary": "GET /wp/v2/templates/lookup", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "in": "query", "schema": { "type": "boolean" }, "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "in": "query", "schema": { "type": "string" }, "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`" } ] } }, "/wp/v2/templates/{id}": { "get": { "summary": "GET /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "put": { "summary": "PUT /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/templates/{id}/autosaves": { "get": { "summary": "GET /wp/v2/templates/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/templates/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } } }, "/wp/v2/templates/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/templates/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/templates/{parent}/revisions": { "get": { "summary": "GET /wp/v2/templates/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/templates/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/templates/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/templates/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/themes": { "get": { "summary": "GET /wp/v2/themes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "active", "inactive" ], "type": "string" } }, "description": "Limit result set to themes assigned one or more statuses." } ] } }, "/wp/v2/themes/{stylesheet}": { "get": { "summary": "GET /wp/v2/themes/{stylesheet}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme's stylesheet. This uniquely identifies the theme." } ] } }, "/wp/v2/types": { "get": { "summary": "GET /wp/v2/types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/types/{type}": { "get": { "summary": "GET /wp/v2/types/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the post type." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/users": { "get": { "summary": "GET /wp/v2/users", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ] }, "description": "Sort collection by user attribute." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users with one or more specific slugs." }, { "name": "roles", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role." }, { "name": "capabilities", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability." }, { "name": "who", "in": "query", "schema": { "type": "string", "enum": [ "authors" ] }, "description": "Limit result set to users who are considered authors." }, { "name": "has_published_posts", "in": "query", "schema": { "type": "boolean" }, "description": "Limit result set to users who have published posts." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "email", "name", "id", "username", "slug" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." } ] }, "post": { "summary": "POST /wp/v2/users", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "username", "email", "password" ] } } } } } }, "/wp/v2/users/me": { "get": { "summary": "GET /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "in": "query", "schema": { "type": "integer" }, "required": true, "description": "Reassign the deleted user's posts and links to this user ID." } ] } }, "/wp/v2/users/{id}": { "get": { "summary": "GET /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "in": "query", "schema": { "type": "integer" }, "required": true, "description": "Reassign the deleted user's posts and links to this user ID." } ] } }, "/wp/v2/users/{user_id}/application-passwords": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } }, "required": [ "name" ] } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/wp/v2/users/{user_id}/application-passwords/introspect": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords/introspect", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/users/{user_id}/application-passwords/{uuid}": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "put": { "summary": "PUT /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/wp/v2/view-config": { "get": { "summary": "GET /wp/v2/view-config", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "kind", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Entity kind." }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Entity name." } ] } }, "/wp/v2/widget-types": { "get": { "summary": "GET /wp/v2/widget-types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/widget-types/{id}": { "get": { "summary": "GET /wp/v2/widget-types/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/widget-types/{id}/encode": { "post": { "summary": "POST /wp/v2/widget-types/{id}/encode", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instance": { "type": "object", "description": "Current instance settings of the widget." }, "form_data": { "type": "string", "description": "Serialized widget form data to encode into instance settings." } } } } } } } }, "/wp/v2/widget-types/{id}/render": { "post": { "summary": "POST /wp/v2/widget-types/{id}/render", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instance": { "type": "object", "description": "Current instance settings of the widget." } } } } } } } }, "/wp/v2/widgets": { "get": { "summary": "GET /wp/v2/widgets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "sidebar", "in": "query", "schema": { "type": "string" }, "description": "The sidebar to return widgets for." } ] }, "post": { "summary": "POST /wp/v2/widgets", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the widget." }, "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "default": "wp_inactive_widgets", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } }, "required": [ "sidebar" ] } } } } } }, "/wp/v2/widgets/{id}": { "get": { "summary": "GET /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "put": { "summary": "PUT /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "schema": { "type": "boolean" }, "description": "Whether to force removal of the widget, or move it to the inactive sidebar." } ] } }, "/wp/v2/wp_pattern_category": { "get": { "summary": "GET /wp/v2/wp_pattern_category", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/wp_pattern_category", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/wp_pattern_category/{id}": { "get": { "summary": "GET /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wpra/v1": { "get": { "summary": "GET /wpra/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wpra/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wpra/v1/ai-sync-credits": { "post": { "summary": "POST /wpra/v1/ai-sync-credits", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1": { "get": { "summary": "GET /yoast/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "yoast/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/yoast/v1/action_tracking": { "post": { "summary": "POST /yoast/v1/action_tracking", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string" } }, "required": [ "action" ] } } } } } }, "/yoast/v1/ai/free_sparks": { "post": { "summary": "POST /yoast/v1/ai/free_sparks", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/ai_content_planner/banner_permanent_dismissal": { "post": { "summary": "POST /yoast/v1/ai_content_planner/banner_permanent_dismissal", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_dismissed": { "type": "string" } }, "required": [ "is_dismissed" ] } } } } } }, "/yoast/v1/ai_content_planner/get_outline": { "post": { "summary": "POST /yoast/v1/ai_content_planner/get_outline", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post_type": { "type": "string", "description": "The post type to get a content outline for." }, "language": { "type": "string", "description": "The language the content is written in." }, "editor": { "type": "string", "enum": [ "classic", "elementor", "gutenberg" ], "description": "The current editor." }, "title": { "type": "string", "description": "The title of the chosen content suggestion." }, "intent": { "type": "string", "description": "The intent of the chosen content suggestion." }, "explanation": { "type": "string", "description": "The explanation of the chosen content suggestion." }, "keyphrase": { "type": "string", "description": "The keyphrase of the chosen content suggestion." }, "meta_description": { "type": "string", "description": "The meta description of the chosen content suggestion." }, "category": { "type": "object", "description": "The category of the chosen content suggestion. Use name \"\" and id -1 to indicate no category." }, "recent_content": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "required": true, "maxLength": 500 }, "description": { "type": "string", "required": true, "maxLength": 1000 } }, "additionalProperties": false }, "description": "The recent content returned by the get_suggestions response." } }, "required": [ "post_type", "language", "editor", "title", "intent", "explanation", "keyphrase", "meta_description", "category", "recent_content" ] } } } } } }, "/yoast/v1/ai_content_planner/get_suggestions": { "get": { "summary": "GET /yoast/v1/ai_content_planner/get_suggestions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "post_type", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The post type to get content suggestions for." }, { "name": "language", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The language the content is written in." }, { "name": "editor", "in": "query", "schema": { "type": "string", "enum": [ "classic", "elementor", "gutenberg" ] }, "required": true, "description": "The current editor." } ] } }, "/yoast/v1/ai_generator/bust_subscription_cache": { "post": { "summary": "POST /yoast/v1/ai_generator/bust_subscription_cache", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/ai_generator/callback": { "post": { "summary": "POST /yoast/v1/ai_generator/callback", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_jwt": { "type": "string", "description": "The access JWT." }, "refresh_jwt": { "type": "string", "description": "The JWT to be used when the access JWT needs to be refreshed." }, "code_challenge": { "type": "string", "description": "The SHA266 of the verification code used to check the authenticity of a callback call." }, "user_id": { "type": "integer", "description": "The id of the user associated to the code verifier." } }, "required": [ "access_jwt", "refresh_jwt", "code_challenge", "user_id" ] } } } } } }, "/yoast/v1/ai_generator/consent": { "post": { "summary": "POST /yoast/v1/ai_generator/consent", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "consent": { "type": "boolean", "description": "Whether the consent to use AI-based services has been given by the user." } }, "required": [ "consent" ] } } } } } }, "/yoast/v1/ai_generator/get_suggestions": { "post": { "summary": "POST /yoast/v1/ai_generator/get_suggestions", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "seo-title", "meta-description", "product-seo-title", "product-meta-description", "product-taxonomy-seo-title", "product-taxonomy-meta-description", "taxonomy-seo-title", "taxonomy-meta-description" ], "description": "The type of suggestion requested." }, "prompt_content": { "type": "string", "description": "The content needed by the prompt to ask for suggestions." }, "focus_keyphrase": { "type": "string", "description": "The focus keyphrase associated to the post." }, "language": { "type": "string", "description": "The language the post is written in." }, "platform": { "type": "string", "enum": [ "Google", "Facebook", "Twitter" ], "description": "The platform the post is intended for." }, "editor": { "type": "string", "enum": [ "classic", "elementor", "gutenberg" ], "description": "The current editor." } }, "required": [ "type", "prompt_content", "focus_keyphrase", "language", "platform", "editor" ] } } } } } }, "/yoast/v1/ai_generator/get_usage": { "post": { "summary": "POST /yoast/v1/ai_generator/get_usage", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_woo_product_entity": { "type": "boolean", "default": false } } } } } } } }, "/yoast/v1/ai_generator/refresh_callback": { "post": { "summary": "POST /yoast/v1/ai_generator/refresh_callback", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "access_jwt": { "type": "string", "description": "The access JWT." }, "refresh_jwt": { "type": "string", "description": "The JWT to be used when the access JWT needs to be refreshed." }, "code_challenge": { "type": "string", "description": "The SHA266 of the verification code used to check the authenticity of a callback call." }, "user_id": { "type": "integer", "description": "The id of the user associated to the code verifier." } }, "required": [ "access_jwt", "refresh_jwt", "code_challenge", "user_id" ] } } } } } }, "/yoast/v1/alerts/dismiss": { "post": { "summary": "POST /yoast/v1/alerts/dismiss", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" } }, "required": [ "key" ] } } } } } }, "/yoast/v1/available_posts": { "get": { "summary": "GET /yoast/v1/available_posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "postType", "in": "query", "schema": { "type": "string", "default": "page" } } ] } }, "/yoast/v1/bulk_editor/posts": { "get": { "summary": "GET /yoast/v1/bulk_editor/posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "content_type", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The content type to fetch posts for." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 20 }, "description": "The number of posts to fetch." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "The page of posts to fetch." }, { "name": "search", "in": "query", "schema": { "type": "string", "default": "" }, "description": "The term to search posts by." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "publish", "draft", "pending", "future" ] }, "default": [ "publish", "draft", "pending", "future" ] }, "description": "The post statuses to include." }, { "name": "needs_improvement", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "seo_title", "meta_description", "social_title", "social_description" ] }, "default": [] }, "description": "The fields to filter posts by; a field matches when it is empty, or (for search fields, while SEO analysis is enabled and the content type shows Yoast's controls and assessments) when its score needs improvement." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "default": [] }, "description": "Limits the posts to these post IDs, e.g. a selection carried over from the posts overview." } ] } }, "/yoast/v1/bulk_editor/posts_content": { "get": { "summary": "GET /yoast/v1/bulk_editor/posts_content", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "array", "items": { "type": "integer", "minimum": 1 } }, "required": true, "description": "The IDs of the posts to return the content of. Accepts a comma separated list." } ] } }, "/yoast/v1/bulk_editor/update_scores": { "post": { "summary": "POST /yoast/v1/bulk_editor/update_scores", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "The per-post score updates to apply." } }, "required": [ "items" ] } } } } } }, "/yoast/v1/bulk_editor/update_search": { "post": { "summary": "POST /yoast/v1/bulk_editor/update_search", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "The per-post updates to apply." } }, "required": [ "items" ] } } } } } }, "/yoast/v1/bulk_editor/update_social": { "post": { "summary": "POST /yoast/v1/bulk_editor/update_social", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "The per-post updates to apply." } }, "required": [ "items" ] } } } } } }, "/yoast/v1/complete_task": { "post": { "summary": "POST /yoast/v1/complete_task", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "options": { "type": "object" } }, "required": [ "options" ] } } } } } }, "/yoast/v1/configuration/check_capability": { "get": { "summary": "GET /yoast/v1/configuration/check_capability", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/yoast/v1/configuration/enable_tracking": { "post": { "summary": "POST /yoast/v1/configuration/enable_tracking", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tracking": { "type": "boolean" } }, "required": [ "tracking" ] } } } } } }, "/yoast/v1/configuration/get_configuration_state": { "get": { "summary": "GET /yoast/v1/configuration/get_configuration_state", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/configuration/save_configuration_state": { "post": { "summary": "POST /yoast/v1/configuration/save_configuration_state", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "finishedSteps": { "type": "array", "items": { "type": "string" } } }, "required": [ "finishedSteps" ] } } } } } }, "/yoast/v1/configuration/site_representation": { "post": { "summary": "POST /yoast/v1/configuration/site_representation", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company_or_person": { "type": "string", "enum": [ "company", "person" ] }, "company_name": { "type": "string" }, "company_logo": { "type": "string" }, "company_logo_id": { "type": "integer" }, "person_logo": { "type": "string" }, "person_logo_id": { "type": "integer" }, "company_or_person_user_id": { "type": "integer" }, "description": { "type": "string" } }, "required": [ "company_or_person" ] } } } } } }, "/yoast/v1/configuration/social_profiles": { "post": { "summary": "POST /yoast/v1/configuration/social_profiles", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "facebook_site": { "type": "string" }, "twitter_site": { "type": "string" }, "other_social_urls": { "type": "array", "items": { "type": "string" } } } } } } } } }, "/yoast/v1/file_size": { "get": { "summary": "GET /yoast/v1/file_size", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The url to retrieve" } ] } }, "/yoast/v1/get_head": { "get": { "summary": "GET /yoast/v1/get_head", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/yoast/v1/get_tasks": { "get": { "summary": "GET /yoast/v1/get_tasks", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "options", "in": "query", "schema": { "type": "object" } } ] } }, "/yoast/v1/import/{plugin}/{type}": { "post": { "summary": "POST /yoast/v1/import/{plugin}/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/yoast/v1/indexing/complete": { "post": { "summary": "POST /yoast/v1/indexing/complete", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/general": { "post": { "summary": "POST /yoast/v1/indexing/general", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/indexables-complete": { "post": { "summary": "POST /yoast/v1/indexing/indexables-complete", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/post-type-archives": { "post": { "summary": "POST /yoast/v1/indexing/post-type-archives", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/posts": { "post": { "summary": "POST /yoast/v1/indexing/posts", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/prepare": { "post": { "summary": "POST /yoast/v1/indexing/prepare", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/indexing/terms": { "post": { "summary": "POST /yoast/v1/indexing/terms", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/integrations/set_active": { "post": { "summary": "POST /yoast/v1/integrations/set_active", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "active": { "type": "boolean" }, "integration": { "type": "string" } }, "required": [ "active", "integration" ] } } } } } }, "/yoast/v1/introductions/{introduction_id}/seen": { "post": { "summary": "POST /yoast/v1/introductions/{introduction_id}/seen", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "introduction_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_seen": { "type": "string", "default": true } } } } } } } }, "/yoast/v1/link-indexing/posts": { "post": { "summary": "POST /yoast/v1/link-indexing/posts", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/link-indexing/terms": { "post": { "summary": "POST /yoast/v1/link-indexing/terms", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/meta/search": { "get": { "summary": "GET /yoast/v1/meta/search", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/new-content-type-visibility/dismiss-post-type": { "post": { "summary": "POST /yoast/v1/new-content-type-visibility/dismiss-post-type", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "postTypeName": { "type": "string" } } } } } } } }, "/yoast/v1/new-content-type-visibility/dismiss-taxonomy": { "post": { "summary": "POST /yoast/v1/new-content-type-visibility/dismiss-taxonomy", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "taxonomyName": { "type": "string" } } } } } } } }, "/yoast/v1/readability_scores": { "get": { "summary": "GET /yoast/v1/readability_scores", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "contentType", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "taxonomy", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "term", "in": "query", "schema": { "type": "integer" } }, { "name": "troubleshooting", "in": "query", "schema": { "type": "string" } } ] } }, "/yoast/v1/schema-aggregator/get-schema/{post_type}": { "get": { "summary": "GET /yoast/v1/schema-aggregator/get-schema/{post_type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "post_type", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/yoast/v1/schema-aggregator/get-schema/{post_type}/{page}": { "get": { "summary": "GET /yoast/v1/schema-aggregator/get-schema/{post_type}/{page}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "post_type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "schema": { "default": 1 } } ] } }, "/yoast/v1/schema-aggregator/get-xml": { "get": { "summary": "GET /yoast/v1/schema-aggregator/get-xml", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/semrush/authenticate": { "post": { "summary": "POST /yoast/v1/semrush/authenticate", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] } } } } } }, "/yoast/v1/semrush/country_code": { "post": { "summary": "POST /yoast/v1/semrush/country_code", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "country_code": { "type": "string" } }, "required": [ "country_code" ] } } } } } }, "/yoast/v1/semrush/related_keyphrases": { "get": { "summary": "GET /yoast/v1/semrush/related_keyphrases", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "keyphrase", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "country_code", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/yoast/v1/seo_scores": { "get": { "summary": "GET /yoast/v1/seo_scores", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "contentType", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "taxonomy", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "term", "in": "query", "schema": { "type": "integer" } }, { "name": "troubleshooting", "in": "query", "schema": { "type": "string" } } ] } }, "/yoast/v1/setup_steps_tracking": { "post": { "summary": "POST /yoast/v1/setup_steps_tracking", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "setup_widget_loaded": { "type": "string", "enum": [ "yes", "no" ] }, "first_interaction_stage": { "type": "string", "enum": [ "install", "activate", "setup", "grantConsent", "successfullyConnected" ] }, "last_interaction_stage": { "type": "string", "enum": [ "install", "activate", "setup", "grantConsent", "successfullyConnected" ] }, "setup_widget_temporarily_dismissed": { "type": "string", "enum": [ "yes", "no" ] }, "setup_widget_permanently_dismissed": { "type": "string", "enum": [ "yes", "no" ] } } } } } } } }, "/yoast/v1/site_kit_configuration_permanent_dismissal": { "post": { "summary": "POST /yoast/v1/site_kit_configuration_permanent_dismissal", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "is_dismissed": { "type": "string" } }, "required": [ "is_dismissed" ] } } } } } }, "/yoast/v1/statistics": { "get": { "summary": "GET /yoast/v1/statistics", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/wincher/account/limit": { "get": { "summary": "GET /yoast/v1/wincher/account/limit", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/wincher/account/upgrade-campaign": { "get": { "summary": "GET /yoast/v1/wincher/account/upgrade-campaign", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/wincher/authenticate": { "post": { "summary": "POST /yoast/v1/wincher/authenticate", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "websiteId": { "type": "string" } }, "required": [ "code", "websiteId" ] } } } } } }, "/yoast/v1/wincher/authorization-url": { "get": { "summary": "GET /yoast/v1/wincher/authorization-url", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/wincher/keyphrases": { "post": { "summary": "POST /yoast/v1/wincher/keyphrases", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keyphrases": { "type": "string" }, "permalink": { "type": "string" }, "startAt": { "type": "string" } } } } } } } }, "/yoast/v1/wincher/keyphrases/track": { "post": { "summary": "POST /yoast/v1/wincher/keyphrases/track", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "keyphrases": { "type": "string" } }, "required": [ "keyphrases" ] } } } } } }, "/yoast/v1/wincher/keyphrases/untrack": { "delete": { "summary": "DELETE /yoast/v1/wincher/keyphrases/untrack", "responses": { "200": { "description": "Successful response" } } } }, "/yoast/v1/wistia_embed_permission": { "get": { "summary": "GET /yoast/v1/wistia_embed_permission", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /yoast/v1/wistia_embed_permission", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "value": { "type": "string", "default": true } } } } } } } }, "/yoast/v1/workouts": { "get": { "summary": "GET /yoast/v1/workouts", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /yoast/v1/workouts", "responses": { "200": { "description": "Successful response" } } } } }, "components": { "schemas": { "Post": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "date_gmt": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "title": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "content": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "excerpt": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "author": { "type": "integer" }, "featured_media": { "type": "integer" }, "categories": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "integer" } } } }, "Page": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "title": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "content": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "excerpt": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "parent": { "type": "integer" }, "menu_order": { "type": "integer" } } }, "Media": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "media_type": { "type": "string" }, "mime_type": { "type": "string" }, "source_url": { "type": "string", "format": "uri" }, "alt_text": { "type": "string" }, "caption": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "media_details": { "type": "object" } } }, "Term": { "type": "object", "properties": { "id": { "type": "integer" }, "count": { "type": "integer" }, "description": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "slug": { "type": "string" }, "taxonomy": { "type": "string" }, "parent": { "type": "integer" } } }, "User": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "avatar_urls": { "type": "object" } } } } } }