# generated: '2026-09-02' # method: derived # source: https://corporate.americangreetings.com/wp-json/ (provider route index) + per-resource OPTIONS schemas openapi: 3.1.0 info: title: American Greetings Corporate WordPress REST API version: '2026-09-02' description: Read-mostly content API served by American Greetings from its corporate site at corporate.americangreetings.com. This is the WordPress REST API (namespace wp/v2 plus oEmbed 1.0) exposed by the WordPress VIP platform the company runs its corporate site on. Alongside the standard WordPress content entities (posts, pages, media, categories, tags, users, comments) it exposes two American Greetings-specific custom post types, /products and /brands, which carry the company's own product and brand catalogue. GET collections are readable anonymously; all write operations require WordPress application-password credentials. This document was DERIVED mechanically from the provider's own machine-readable route index at https://corporate.americangreetings.com/wp-json/ and per-resource OPTIONS schemas — American Greetings does not publish an OpenAPI description of its own. contact: name: American Greetings url: https://corporate.americangreetings.com/about-us/contact-us/ servers: - url: https://corporate.americangreetings.com/wp-json description: American Greetings corporate WordPress REST API tags: - name: wp/v2 description: WordPress core content namespace, including the American Greetings products and brands custom post types. - name: oembed/1.0 description: oEmbed discovery and proxy endpoints. paths: /oembed/1.0: get: operationId: get_oembed_1_0 summary: GET /oembed/1.0 tags: - oembed/1.0 parameters: - name: namespace in: query required: false description: '' schema: default: oembed/1.0 - name: context in: query required: false description: '' schema: default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /oembed/1.0/embed: get: operationId: get_oembed_1_0_embed summary: GET /oembed/1.0/embed tags: - oembed/1.0 parameters: - name: url in: query required: true description: The URL of the resource for which to fetch oEmbed data. schema: type: string format: uri - name: format in: query required: false description: '' schema: default: json - name: maxwidth in: query required: false description: '' schema: default: 600 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /oembed/1.0/proxy: get: operationId: get_oembed_1_0_proxy summary: GET /oembed/1.0/proxy tags: - oembed/1.0 parameters: - name: url in: query required: true description: The URL of the resource for which to fetch oEmbed data. schema: type: string format: uri - name: format in: query required: false description: The oEmbed format to use. schema: type: string enum: - json - xml default: json - name: maxwidth in: query required: false description: The maximum width of the embed frame in pixels. schema: type: integer default: 600 - name: maxheight in: query required: false description: The maximum height of the embed frame in pixels. schema: type: integer - name: discover in: query required: false description: Whether to perform an oEmbed discovery request for unsanctioned providers. schema: type: boolean default: true responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2: get: operationId: get_wp_v2 summary: GET /wp/v2 tags: - wp/v2 parameters: - name: namespace in: query required: false description: '' schema: default: wp/v2 - name: context in: query required: false description: '' schema: default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/activity-log-events: get: operationId: get_wp_v2_activity_log_events summary: GET /wp/v2/activity-log-events tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_activity_log_events summary: POST /wp/v2/activity-log-events tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/activity-log-events/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_activity_log_events_id summary: GET /wp/v2/activity-log-events/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_activity_log_events_id summary: POST /wp/v2/activity-log-events/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_activity_log_events_id summary: PUT /wp/v2/activity-log-events/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_activity_log_events_id summary: PATCH /wp/v2/activity-log-events/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_activity_log_events_id summary: DELETE /wp/v2/activity-log-events/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/activity-log-events/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_activity_log_events_id_autosaves summary: GET /wp/v2/activity-log-events/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_activity_log_events_id_autosaves summary: POST /wp/v2/activity-log-events/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/activity-log-events/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_activity_log_events_parent_autosaves_id summary: GET /wp/v2/activity-log-events/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-directory/search: get: operationId: get_wp_v2_block_directory_search summary: GET /wp/v2/block-directory/search tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: term in: query required: true description: Limit result set to blocks matching the search term. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-patterns/categories: get: operationId: get_wp_v2_block_patterns_categories summary: GET /wp/v2/block-patterns/categories tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-patterns/patterns: get: operationId: get_wp_v2_block_patterns_patterns summary: GET /wp/v2/block-patterns/patterns tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-renderer/{name}: parameters: - name: name in: path required: true schema: type: string get: operationId: get_wp_v2_block_renderer_name summary: GET /wp/v2/block-renderer/{name} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - edit default: view - name: attributes in: query required: false description: Attributes for the block. schema: type: object default: [] - name: post_id in: query required: false description: ID of the post context. schema: type: integer responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_block_renderer_name summary: POST /wp/v2/block-renderer/{name} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - edit default: view 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/block-types: get: operationId: get_wp_v2_block_types summary: GET /wp/v2/block-types tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: namespace in: query required: false description: Block namespace. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-types/{namespace}: parameters: - name: namespace in: path required: true schema: type: string get: operationId: get_wp_v2_block_types_namespace summary: GET /wp/v2/block-types/{namespace} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-types/{namespace}/{name}: parameters: - name: namespace in: path required: true schema: type: string - name: name in: path required: true schema: type: string get: operationId: get_wp_v2_block_types_namespace_name summary: GET /wp/v2/block-types/{namespace}/{name} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks: get: operationId: get_wp_v2_blocks summary: GET /wp/v2/blocks tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string - name: tax_relation in: query required: false description: Limit result set based on relationship between multiple taxonomies. schema: type: string enum: - AND - OR - name: wp_pattern_category in: query required: false description: Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] operator: description: Whether items must be assigned all or any of the specified terms. type: string enum: - AND - OR default: OR additionalProperties: false - name: wp_pattern_category_exclude in: query required: false description: Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] additionalProperties: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_blocks summary: POST /wp/v2/blocks tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - view - edit description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: wp_pattern_sync_status: type: string title: '' description: '' default: '' enum: - partial - unsynced footnotes: type: string title: '' description: '' default: '' 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/blocks/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_blocks_id summary: GET /wp/v2/blocks/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_blocks_id summary: POST /wp/v2/blocks/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - view - edit description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: wp_pattern_sync_status: type: string title: '' description: '' default: '' enum: - partial - unsynced footnotes: type: string title: '' description: '' default: '' 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_blocks_id summary: PUT /wp/v2/blocks/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - view - edit description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: wp_pattern_sync_status: type: string title: '' description: '' default: '' enum: - partial - unsynced footnotes: type: string title: '' description: '' default: '' 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_blocks_id summary: PATCH /wp/v2/blocks/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - view - edit description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: wp_pattern_sync_status: type: string title: '' description: '' default: '' enum: - partial - unsynced footnotes: type: string title: '' description: '' default: '' 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_blocks_id summary: DELETE /wp/v2/blocks/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/blocks/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_blocks_id_autosaves summary: GET /wp/v2/blocks/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_blocks_id_autosaves summary: POST /wp/v2/blocks/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - view - edit description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: wp_pattern_sync_status: type: string title: '' description: '' default: '' enum: - partial - unsynced footnotes: type: string title: '' description: '' default: '' 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/blocks/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_blocks_parent_autosaves_id summary: GET /wp/v2/blocks/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_blocks_parent_revisions summary: GET /wp/v2/blocks/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_blocks_parent_revisions_id summary: GET /wp/v2/blocks/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_blocks_parent_revisions_id summary: DELETE /wp/v2/blocks/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/brands: get: operationId: get_wp_v2_brands summary: GET /wp/v2/brands tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: menu_order in: query required: false description: Limit result set to posts with a specific menu_order value. schema: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array default: [] items: type: integer - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_brands summary: POST /wp/v2/brands tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/brands/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_brands_id summary: GET /wp/v2/brands/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_brands_id summary: POST /wp/v2/brands/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_brands_id summary: PUT /wp/v2/brands/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_brands_id summary: PATCH /wp/v2/brands/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_brands_id summary: DELETE /wp/v2/brands/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Brand' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/brands/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_brands_id_autosaves summary: GET /wp/v2/brands/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_brands_id_autosaves summary: POST /wp/v2/brands/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the post. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/brands/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_brands_parent_autosaves_id summary: GET /wp/v2/brands/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/brands/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_brands_parent_revisions summary: GET /wp/v2/brands/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/brands/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_brands_parent_revisions_id summary: GET /wp/v2/brands/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_brands_parent_revisions_id summary: DELETE /wp/v2/brands/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/categories: get: operationId: get_wp_v2_categories summary: GET /wp/v2/categories tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name - name: hide_empty in: query required: false description: Whether to hide terms not assigned to any posts. schema: type: boolean default: false - name: parent in: query required: false description: Limit result set to terms assigned to a specific parent. schema: type: integer - name: post in: query required: false description: Limit result set to terms assigned to a specific post. schema: type: integer default: null - name: slug in: query required: false description: Limit result set to terms with one or more specific slugs. schema: type: array items: type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_categories summary: POST /wp/v2/categories tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. required: - name responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/categories/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_categories_id summary: GET /wp/v2/categories/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_categories_id summary: POST /wp/v2/categories/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_categories_id summary: PUT /wp/v2/categories/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_categories_id summary: PATCH /wp/v2/categories/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_categories_id summary: DELETE /wp/v2/categories/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as terms do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/comments: get: operationId: get_wp_v2_comments summary: GET /wp/v2/comments tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to comments published after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to comments assigned to specific user IDs. Requires authorization. schema: type: array items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization. schema: type: array items: type: integer - name: author_email in: query required: false description: Limit result set to that from a specific author email. Requires authorization. schema: type: string format: email default: null - name: before in: query required: false description: Limit response to comments published before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by comment attribute. schema: type: string enum: - date - date_gmt - id - include - post - parent - type default: date_gmt - name: parent in: query required: false description: Limit result set to comments of specific parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Ensure result set excludes specific parent IDs. schema: type: array default: [] items: type: integer - name: post in: query required: false description: Limit result set to comments assigned to specific post IDs. schema: type: array default: [] items: type: integer - name: status in: query required: false description: Limit result set to comments assigned a specific status. Requires authorization. schema: type: string default: approve - name: type in: query required: false description: Limit result set to comments assigned a specific type. Requires authorization. schema: type: string default: comment - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_comments summary: POST /wp/v2/comments tags: - wp/v2 requestBody: required: false 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 properties: raw: description: Content for the comment, as it exists in the database. type: string context: - edit rendered: description: HTML content for the comment, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/comments/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_comments_id summary: GET /wp/v2/comments/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the parent post of the comment (if the post is password protected). schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_comments_id summary: POST /wp/v2/comments/{id} tags: - wp/v2 requestBody: required: false 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 properties: raw: description: Content for the comment, as it exists in the database. type: string context: - edit rendered: description: HTML content for the comment, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_comments_id summary: PUT /wp/v2/comments/{id} tags: - wp/v2 requestBody: required: false 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 properties: raw: description: Content for the comment, as it exists in the database. type: string context: - edit rendered: description: HTML content for the comment, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_comments_id summary: PATCH /wp/v2/comments/{id} tags: - wp/v2 requestBody: required: false 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 properties: raw: description: Content for the comment, as it exists in the database. type: string context: - edit rendered: description: HTML content for the comment, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_comments_id summary: DELETE /wp/v2/comments/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false - name: password in: query required: false description: The password for the parent post of the comment (if the post is password protected). schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback: get: operationId: get_wp_v2_feedback summary: GET /wp/v2/feedback tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array default: [] items: type: integer - name: source in: query required: false description: Limit result set to feedback submitted from a particular source post ID. schema: type: integer - name: is_unread in: query required: false description: Limit result set to read or unread feedback items. schema: type: boolean - name: is_test in: query required: false description: Limit result set to test responses (from form preview) or exclude them. schema: type: boolean - name: invalid_ids in: query required: false description: List of item IDs to include in results regardless of filters. schema: type: array default: [] items: type: integer - name: fields_format in: query required: false description: Format for the fields data in the response. schema: type: string enum: - label-value - collection default: label-value responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_feedback summary: POST /wp/v2/feedback tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_feedback_id summary: GET /wp/v2/feedback/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_feedback_id summary: POST /wp/v2/feedback/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_feedback_id summary: PUT /wp/v2/feedback/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_feedback_id summary: PATCH /wp/v2/feedback/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_feedback_id summary: DELETE /wp/v2/feedback/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/{id}/read: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_feedback_id_read summary: POST /wp/v2/feedback/{id}/read tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: is_unread: type: boolean required: - is_unread responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/bulk_actions: post: operationId: post_wp_v2_feedback_bulk_actions summary: POST /wp/v2/feedback/bulk_actions tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: action: type: string enum: - mark_as_spam - mark_as_not_spam post_ids: type: array items: type: integer required: - action - post_ids responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/config: get: operationId: get_wp_v2_feedback_config summary: GET /wp/v2/feedback/config tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/feedback/counts: get: operationId: get_wp_v2_feedback_counts summary: GET /wp/v2/feedback/counts tags: - wp/v2 parameters: - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: parent in: query required: false description: Limit results to those of a specific parent ID. schema: type: integer - name: before in: query required: false description: Limit results to feedback published before a given ISO8601 compliant date. schema: type: string format: date-time - name: after in: query required: false description: Limit results to feedback published after a given ISO8601 compliant date. schema: type: string format: date-time - name: is_unread in: query required: false description: Limit results to read or unread feedback items. schema: type: boolean - name: is_test in: query required: false description: Limit results to test responses or exclude them. schema: type: boolean - name: source in: query required: false description: Limit results to feedback submitted from a specific source post ID. schema: type: integer responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/feedback/dismiss-classic-forms-notice: post: operationId: post_wp_v2_feedback_dismiss_classic_forms_notice summary: POST /wp/v2/feedback/dismiss-classic-forms-notice tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/filters: get: operationId: get_wp_v2_feedback_filters summary: GET /wp/v2/feedback/filters tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/feedback/integrations: get: operationId: get_wp_v2_feedback_integrations summary: GET /wp/v2/feedback/integrations tags: - wp/v2 parameters: - name: version in: query required: false description: '' schema: type: integer default: 1 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/feedback/integrations-metadata: get: operationId: get_wp_v2_feedback_integrations_metadata summary: GET /wp/v2/feedback/integrations-metadata tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/feedback/integrations/{slug}: parameters: - name: slug in: path required: true schema: type: string get: operationId: get_wp_v2_feedback_integrations_slug summary: GET /wp/v2/feedback/integrations/{slug} tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_feedback_integrations_slug summary: DELETE /wp/v2/feedback/integrations/{slug} tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/feedback/trash: delete: operationId: delete_wp_v2_feedback_trash summary: DELETE /wp/v2/feedback/trash tags: - wp/v2 parameters: - name: status in: query required: false description: '' schema: type: string enum: - trash - spam default: trash responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/font-collections: get: operationId: get_wp_v2_font_collections summary: GET /wp/v2/font-collections tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/font-collections/{slug}: parameters: - name: slug in: path required: true schema: type: string get: operationId: get_wp_v2_font_collections_slug summary: GET /wp/v2/font-collections/{slug} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/font-families: get: operationId: get_wp_v2_font_families summary: GET /wp/v2/font-families tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - id - include default: id - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_font_families summary: POST /wp/v2/font-families tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/font-families/{font_family_id}/font-faces: parameters: - name: font_family_id in: path required: true schema: type: integer get: operationId: get_wp_v2_font_families_font_family_id_font_faces summary: GET /wp/v2/font-families/{font_family_id}/font-faces tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - id - include default: id responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_font_families_font_family_id_font_faces summary: POST /wp/v2/font-families/{font_family_id}/font-faces tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/font-families/{font_family_id}/font-faces/{id}: parameters: - name: font_family_id in: path required: true schema: type: integer - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_font_families_font_family_id_font_faces_id summary: GET /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_font_families_font_family_id_font_faces_id summary: DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/font-families/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_font_families_id summary: GET /wp/v2/font-families/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_font_families_id summary: POST /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_font_families_id summary: PUT /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_font_families_id summary: PATCH /wp/v2/font-families/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: theme_json_version: type: integer default: 3 minimum: 2 maximum: 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_font_families_id summary: DELETE /wp/v2/font-families/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/global-styles/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_global_styles_id summary: GET /wp/v2/global-styles/{id} tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_global_styles_id summary: POST /wp/v2/global-styles/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: styles: type: - object description: Global styles. settings: type: - object description: Global settings. title: type: - object - string properties: raw: description: Title for the global styles variation, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_global_styles_id summary: PUT /wp/v2/global-styles/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: styles: type: - object description: Global styles. settings: type: - object description: Global settings. title: type: - object - string properties: raw: description: Title for the global styles variation, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_global_styles_id summary: PATCH /wp/v2/global-styles/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: styles: type: - object description: Global styles. settings: type: - object description: Global settings. title: type: - object - string properties: raw: description: Title for the global styles variation, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of the global styles variation. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/global-styles/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_global_styles_parent_revisions summary: GET /wp/v2/global-styles/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_global_styles_parent_revisions_id summary: GET /wp/v2/global-styles/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/themes/{stylesheet}\[\]\@_\-]+)/variations: parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: get_wp_v2_global_styles_themes_stylesheet_variations summary: GET /wp/v2/global-styles/themes/{stylesheet}\[\]\@_\-]+)/variations tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/themes/{stylesheet}?): parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: get_wp_v2_global_styles_themes_stylesheet summary: GET /wp/v2/global-styles/themes/{stylesheet}?) tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icon-collections: get: operationId: get_wp_v2_icon_collections summary: GET /wp/v2/icon-collections tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icon-collections/{slug}?): parameters: - name: slug in: path required: true schema: type: string get: operationId: get_wp_v2_icon_collections_slug summary: GET /wp/v2/icon-collections/{slug}?) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icons: get: operationId: get_wp_v2_icons summary: GET /wp/v2/icons tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: collection in: query required: false description: Limit results to icons belonging to the given collection slug. schema: type: string pattern: ^[a-z0-9]([a-z0-9_-]*[a-z0-9])?$ responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icons/{collection}?): parameters: - name: collection in: path required: true schema: type: string get: operationId: get_wp_v2_icons_collection summary: GET /wp/v2/icons/{collection}?) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icons/{name}?/[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?): parameters: - name: name in: path required: true schema: type: string get: operationId: get_wp_v2_icons_name_a_z0_9_a_z0_9_a_z0_9 summary: GET /wp/v2/icons/{name}?/[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-forms: get: operationId: get_wp_v2_jetpack_forms summary: GET /wp/v2/jetpack-forms tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string - name: jetpack_forms_context in: query required: false description: Request context for Jetpack Forms. Use "dashboard" to include dashboard-only fields. schema: type: string enum: - '' - dashboard default: '' - name: has_responses in: query required: false description: Filter forms by whether they have responses. "true" returns only forms with responses, "false" returns only forms without. schema: type: string enum: - '' - 'true' - 'false' default: '' responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_forms summary: POST /wp/v2/jetpack-forms tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. meta: type: object properties: _jetpack_forms_source_post_id: type: integer title: '' description: '' default: 0 footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-forms/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_forms_id summary: GET /wp/v2/jetpack-forms/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_forms_id summary: POST /wp/v2/jetpack-forms/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. meta: type: object properties: _jetpack_forms_source_post_id: type: integer title: '' description: '' default: 0 footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_jetpack_forms_id summary: PUT /wp/v2/jetpack-forms/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. meta: type: object properties: _jetpack_forms_source_post_id: type: integer title: '' description: '' default: 0 footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_jetpack_forms_id summary: PATCH /wp/v2/jetpack-forms/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. meta: type: object properties: _jetpack_forms_source_post_id: type: integer title: '' description: '' default: 0 footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_jetpack_forms_id summary: DELETE /wp/v2/jetpack-forms/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-forms/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_forms_id_autosaves summary: GET /wp/v2/jetpack-forms/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_forms_id_autosaves summary: POST /wp/v2/jetpack-forms/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. meta: type: object properties: _jetpack_forms_source_post_id: type: integer title: '' description: '' default: 0 footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-forms/{id}/preview-url: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_forms_id_preview_url summary: GET /wp/v2/jetpack-forms/{id}/preview-url tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-forms/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_forms_parent_autosaves_id summary: GET /wp/v2/jetpack-forms/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-forms/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_jetpack_forms_parent_revisions summary: GET /wp/v2/jetpack-forms/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-forms/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_forms_parent_revisions_id summary: GET /wp/v2/jetpack-forms/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_jetpack_forms_parent_revisions_id summary: DELETE /wp/v2/jetpack-forms/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-forms/status-counts: get: operationId: get_wp_v2_jetpack_forms_status_counts summary: GET /wp/v2/jetpack-forms/status-counts tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-search-overlay: get: operationId: get_wp_v2_jetpack_search_overlay summary: GET /wp/v2/jetpack-search-overlay tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_search_overlay summary: POST /wp/v2/jetpack-search-overlay tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-search-overlay/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_search_overlay_id summary: GET /wp/v2/jetpack-search-overlay/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_search_overlay_id summary: POST /wp/v2/jetpack-search-overlay/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_jetpack_search_overlay_id summary: PUT /wp/v2/jetpack-search-overlay/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_jetpack_search_overlay_id summary: PATCH /wp/v2/jetpack-search-overlay/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_jetpack_search_overlay_id summary: DELETE /wp/v2/jetpack-search-overlay/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-search-overlay/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_search_overlay_id_autosaves summary: GET /wp/v2/jetpack-search-overlay/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jetpack_search_overlay_id_autosaves summary: POST /wp/v2/jetpack-search-overlay/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jetpack-search-overlay/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_search_overlay_parent_autosaves_id summary: GET /wp/v2/jetpack-search-overlay/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-search-overlay/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_jetpack_search_overlay_parent_revisions summary: GET /wp/v2/jetpack-search-overlay/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/jetpack-search-overlay/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jetpack_search_overlay_parent_revisions_id summary: GET /wp/v2/jetpack-search-overlay/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_jetpack_search_overlay_parent_revisions_id summary: DELETE /wp/v2/jetpack-search-overlay/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_order: get: operationId: get_wp_v2_jp_pay_order summary: GET /wp/v2/jp_pay_order tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jp_pay_order summary: POST /wp/v2/jp_pay_order tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_order/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jp_pay_order_id summary: GET /wp/v2/jp_pay_order/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jp_pay_order_id summary: POST /wp/v2/jp_pay_order/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_jp_pay_order_id summary: PUT /wp/v2/jp_pay_order/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_jp_pay_order_id summary: PATCH /wp/v2/jp_pay_order/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. meta: type: object properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_jp_pay_order_id summary: DELETE /wp/v2/jp_pay_order/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_product: get: operationId: get_wp_v2_jp_pay_product summary: GET /wp/v2/jp_pay_product tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jp_pay_product summary: POST /wp/v2/jp_pay_product tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content 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. meta: type: object properties: spay_price: type: number title: '' description: Simple payments; price. default: 0 spay_currency: type: string title: '' description: Simple payments; currency code. default: '' spay_cta: type: string title: '' description: Simple payments; text with "Buy" or other CTA default: '' spay_multiple: type: boolean title: '' description: Simple payments; allow multiple items default: false spay_email: type: string title: '' description: Simple payments button; paypal email. default: '' spay_status: type: string title: '' description: Simple payments; status. default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_product/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jp_pay_product_id summary: GET /wp/v2/jp_pay_product/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jp_pay_product_id summary: POST /wp/v2/jp_pay_product/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content 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. meta: type: object properties: spay_price: type: number title: '' description: Simple payments; price. default: 0 spay_currency: type: string title: '' description: Simple payments; currency code. default: '' spay_cta: type: string title: '' description: Simple payments; text with "Buy" or other CTA default: '' spay_multiple: type: boolean title: '' description: Simple payments; allow multiple items default: false spay_email: type: string title: '' description: Simple payments button; paypal email. default: '' spay_status: type: string title: '' description: Simple payments; status. default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_jp_pay_product_id summary: PUT /wp/v2/jp_pay_product/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content 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. meta: type: object properties: spay_price: type: number title: '' description: Simple payments; price. default: 0 spay_currency: type: string title: '' description: Simple payments; currency code. default: '' spay_cta: type: string title: '' description: Simple payments; text with "Buy" or other CTA default: '' spay_multiple: type: boolean title: '' description: Simple payments; allow multiple items default: false spay_email: type: string title: '' description: Simple payments button; paypal email. default: '' spay_status: type: string title: '' description: Simple payments; status. default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_jp_pay_product_id summary: PATCH /wp/v2/jp_pay_product/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content 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. meta: type: object properties: spay_price: type: number title: '' description: Simple payments; price. default: 0 spay_currency: type: string title: '' description: Simple payments; currency code. default: '' spay_cta: type: string title: '' description: Simple payments; text with "Buy" or other CTA default: '' spay_multiple: type: boolean title: '' description: Simple payments; allow multiple items default: false spay_email: type: string title: '' description: Simple payments button; paypal email. default: '' spay_status: type: string title: '' description: Simple payments; status. default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_jp_pay_product_id summary: DELETE /wp/v2/jp_pay_product/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_product/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jp_pay_product_id_autosaves summary: GET /wp/v2/jp_pay_product/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_jp_pay_product_id_autosaves summary: POST /wp/v2/jp_pay_product/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content 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. meta: type: object properties: spay_price: type: number title: '' description: Simple payments; price. default: 0 spay_currency: type: string title: '' description: Simple payments; currency code. default: '' spay_cta: type: string title: '' description: Simple payments; text with "Buy" or other CTA default: '' spay_multiple: type: boolean title: '' description: Simple payments; allow multiple items default: false spay_email: type: string title: '' description: Simple payments button; paypal email. default: '' spay_status: type: string title: '' description: Simple payments; status. default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/jp_pay_product/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_jp_pay_product_parent_autosaves_id summary: GET /wp/v2/jp_pay_product/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/media: get: operationId: get_wp_v2_media summary: GET /wp/v2/media tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array default: [] items: type: integer - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: inherit items: enum: - inherit - private - trash type: string - name: media_type in: query required: false description: Limit result set to attachments of a particular media type or media types. schema: type: array default: null items: type: string enum: - image - video - audio - application - name: mime_type in: query required: false description: Limit result set to attachments of a particular MIME type or MIME types. schema: type: array default: null items: type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_media summary: POST /wp/v2/media tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? alt_text: type: string description: Alternative text to display when attachment is not displayed. caption: type: object properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: The attachment caption. description: type: object properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/media/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_media_id summary: GET /wp/v2/media/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_media_id summary: POST /wp/v2/media/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? alt_text: type: string description: Alternative text to display when attachment is not displayed. caption: type: object properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: The attachment caption. description: type: object properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true description: The attachment description. post: type: integer description: The ID for the associated post of the attachment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_media_id summary: PUT /wp/v2/media/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? alt_text: type: string description: Alternative text to display when attachment is not displayed. caption: type: object properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: The attachment caption. description: type: object properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true description: The attachment description. post: type: integer description: The ID for the associated post of the attachment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_media_id summary: PATCH /wp/v2/media/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true 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 properties: [] description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? alt_text: type: string description: Alternative text to display when attachment is not displayed. caption: type: object properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: The attachment caption. description: type: object properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true description: The attachment description. post: type: integer description: The ID for the associated post of the attachment. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_media_id summary: DELETE /wp/v2/media/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/media/{id}/edit: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_media_id_edit summary: POST /wp/v2/media/{id}/edit tags: - wp/v2 requestBody: required: false 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 minimum: 0 maximum: 360 description: 'The amount to rotate the image clockwise in degrees. DEPRECATED: Use `modifiers` instead.' x: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the x position to start the crop from. DEPRECATED: Use `modifiers` instead.' y: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the y position to start the crop from. DEPRECATED: Use `modifiers` instead.' width: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the width to crop the image to. DEPRECATED: Use `modifiers` instead.' height: type: number minimum: 0 maximum: 100 description: 'As a percentage of the image, the height to crop the image to. DEPRECATED: Use `modifiers` instead.' caption: type: object properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: The attachment caption. description: type: object properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true description: The attachment description. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/media/{id}/finalize: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_media_id_finalize summary: POST /wp/v2/media/{id}/finalize tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: sub_sizes: type: array default: [] 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 description: Array of sub-size metadata collected from sideload responses. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/media/{id}/post-process: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_media_id_post_process summary: POST /wp/v2/media/{id}/post-process tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/media/{id}/sideload: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_media_id_sideload summary: POST /wp/v2/media/{id}/sideload tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: image_size: type: - string - array items: type: string minLength: 1 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/menu-items: get: operationId: get_wp_v2_menu_items summary: GET /wp/v2/menu-items tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 100 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: menu_order - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string - name: tax_relation in: query required: false description: Limit result set based on relationship between multiple taxonomies. schema: type: string enum: - AND - OR - name: menus in: query required: false description: Limit result set to items with specific terms assigned in the menus taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] operator: description: Whether items must be assigned all or any of the specified terms. type: string enum: - AND - OR default: OR additionalProperties: false - name: menus_exclude in: query required: false description: Limit result set to items except those with specific terms assigned in the menus taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] additionalProperties: false - name: menu_order in: query required: false description: Limit result set to posts with a specific menu_order value. schema: type: integer responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_menu_items summary: POST /wp/v2/menu-items tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object properties: raw: description: Title for the object, as it exists in the database. type: string context: - edit rendered: description: HTML title for the object, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the object. type: type: string enum: - taxonomy - post_type - post_type_archive - custom default: custom description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: - publish - future - draft - pending - private - spam default: publish description: A named status for the object. parent: type: integer default: 0 minimum: 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 minimum: 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 minimum: 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/menu-items/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_menu_items_id summary: GET /wp/v2/menu-items/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_menu_items_id summary: POST /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object properties: raw: description: Title for the object, as it exists in the database. type: string context: - edit rendered: description: HTML title for the object, transformed for display. type: string context: - view - edit - embed readonly: true 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 - spam description: A named status for the object. parent: type: integer minimum: 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 minimum: 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 minimum: 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_menu_items_id summary: PUT /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object properties: raw: description: Title for the object, as it exists in the database. type: string context: - edit rendered: description: HTML title for the object, transformed for display. type: string context: - view - edit - embed readonly: true 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 - spam description: A named status for the object. parent: type: integer minimum: 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 minimum: 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 minimum: 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_menu_items_id summary: PATCH /wp/v2/menu-items/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: title: type: - string - object properties: raw: description: Title for the object, as it exists in the database. type: string context: - edit rendered: description: HTML title for the object, transformed for display. type: string context: - view - edit - embed readonly: true 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 - spam description: A named status for the object. parent: type: integer minimum: 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 minimum: 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 minimum: 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_menu_items_id summary: DELETE /wp/v2/menu-items/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/menu-items/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_menu_items_id_autosaves summary: GET /wp/v2/menu-items/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_menu_items_id_autosaves summary: POST /wp/v2/menu-items/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer minimum: 0 description: The ID for the parent of the object. title: type: - string - object properties: raw: description: Title for the object, as it exists in the database. type: string context: - edit rendered: description: HTML title for the object, transformed for display. type: string context: - view - edit - embed readonly: true 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 - spam 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 minimum: 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 minimum: 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/menu-items/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_menu_items_parent_autosaves_id summary: GET /wp/v2/menu-items/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menu-locations: get: operationId: get_wp_v2_menu_locations summary: GET /wp/v2/menu-locations tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menu-locations/{location}: parameters: - name: location in: path required: true schema: type: string get: operationId: get_wp_v2_menu_locations_location summary: GET /wp/v2/menu-locations/{location} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menus: get: operationId: get_wp_v2_menus summary: GET /wp/v2/menus tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name - name: hide_empty in: query required: false description: Whether to hide terms not assigned to any posts. schema: type: boolean default: false - name: post in: query required: false description: Limit result set to terms assigned to a specific post. schema: type: integer default: null - name: slug in: query required: false description: Limit result set to terms with one or more specific slugs. schema: type: array items: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_menus summary: POST /wp/v2/menus tags: - wp/v2 requestBody: required: false 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 properties: [] 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/menus/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_menus_id summary: GET /wp/v2/menus/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_menus_id summary: POST /wp/v2/menus/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_menus_id summary: PUT /wp/v2/menus/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_menus_id summary: PATCH /wp/v2/menus/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_menus_id summary: DELETE /wp/v2/menus/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as terms do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/navigation: get: operationId: get_wp_v2_navigation summary: GET /wp/v2/navigation tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_navigation summary: POST /wp/v2/navigation tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit - embed readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit - embed readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/navigation/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_navigation_id summary: GET /wp/v2/navigation/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_navigation_id summary: POST /wp/v2/navigation/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit - embed readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit - embed readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_navigation_id summary: PUT /wp/v2/navigation/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit - embed readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit - embed readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_navigation_id summary: PATCH /wp/v2/navigation/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit - embed readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit - embed readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_navigation_id summary: DELETE /wp/v2/navigation/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/navigation/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_navigation_id_autosaves summary: GET /wp/v2/navigation/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_navigation_id_autosaves summary: POST /wp/v2/navigation/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit - embed rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit - embed readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit - embed readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. template: type: string description: The theme file to use to display the post. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/navigation/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_navigation_parent_autosaves_id summary: GET /wp/v2/navigation/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/navigation/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_navigation_parent_revisions summary: GET /wp/v2/navigation/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/navigation/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_navigation_parent_revisions_id summary: GET /wp/v2/navigation/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_navigation_parent_revisions_id summary: DELETE /wp/v2/navigation/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/pages: get: operationId: get_wp_v2_pages summary: GET /wp/v2/pages tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: menu_order in: query required: false description: Limit result set to posts with a specific menu_order value. schema: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array default: [] items: type: integer - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_pages summary: POST /wp/v2/pages tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/pages/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_pages_id summary: GET /wp/v2/pages/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_pages_id summary: POST /wp/v2/pages/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_pages_id summary: PUT /wp/v2/pages/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_pages_id summary: PATCH /wp/v2/pages/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_pages_id summary: DELETE /wp/v2/pages/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/pages/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_pages_id_autosaves summary: GET /wp/v2/pages/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_pages_id_autosaves summary: POST /wp/v2/pages/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the post. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/pages/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_pages_parent_autosaves_id summary: GET /wp/v2/pages/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/pages/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_pages_parent_revisions summary: GET /wp/v2/pages/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/pages/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_pages_parent_revisions_id summary: GET /wp/v2/pages/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_pages_parent_revisions_id summary: DELETE /wp/v2/pages/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/pattern-directory/patterns: get: operationId: get_wp_v2_pattern_directory_patterns summary: GET /wp/v2/pattern-directory/patterns tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 100 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: category in: query required: false description: Limit results to those matching a category ID. schema: type: integer minimum: 1 - name: keyword in: query required: false description: Limit results to those matching a keyword ID. schema: type: integer minimum: 1 - name: slug in: query required: false description: Limit results to those matching a pattern (slug). schema: type: array - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - favorite_count default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/plugins: get: operationId: get_wp_v2_plugins summary: GET /wp/v2/plugins tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: status in: query required: false description: Limits results to plugins with the given status. schema: type: array items: type: string enum: - inactive - active - network-active responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_plugins summary: POST /wp/v2/plugins tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[\w\-]+' description: WordPress.org plugin directory slug. status: type: string enum: - inactive - active - network-active default: inactive description: The plugin activation status. required: - slug responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/plugins/{plugin}?): parameters: - name: plugin in: path required: true schema: type: string get: operationId: get_wp_v2_plugins_plugin summary: GET /wp/v2/plugins/{plugin}?) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_plugins_plugin summary: POST /wp/v2/plugins/{plugin}?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: - inactive - active - network-active description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_plugins_plugin summary: PUT /wp/v2/plugins/{plugin}?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: - inactive - active - network-active description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_plugins_plugin summary: PATCH /wp/v2/plugins/{plugin}?) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: context: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: - inactive - active - network-active description: The plugin activation status. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_plugins_plugin summary: DELETE /wp/v2/plugins/{plugin}?) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/posts: get: operationId: get_wp_v2_posts summary: GET /wp/v2/posts tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: author in: query required: false description: Limit result set to posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array default: [] items: type: integer - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string - name: tax_relation in: query required: false description: Limit result set based on relationship between multiple taxonomies. schema: type: string enum: - AND - OR - name: categories in: query required: false description: Limit result set to items with specific terms assigned in the categories taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] include_children: description: Whether to include child terms in the terms limiting the result set. type: boolean default: false operator: description: Whether items must be assigned all or any of the specified terms. type: string enum: - AND - OR default: OR additionalProperties: false - name: categories_exclude in: query required: false description: Limit result set to items except those with specific terms assigned in the categories taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] include_children: description: Whether to include child terms in the terms limiting the result set. type: boolean default: false additionalProperties: false - name: tags in: query required: false description: Limit result set to items with specific terms assigned in the tags taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] operator: description: Whether items must be assigned all or any of the specified terms. type: string enum: - AND - OR default: OR additionalProperties: false - name: tags_exclude in: query required: false description: Limit result set to items except those with specific terms assigned in the tags taxonomy. schema: type: - object - array oneOf: - title: Term ID List description: Match terms with the listed IDs. type: array items: type: integer - title: Term ID Taxonomy Query description: Perform an advanced term query. type: object properties: terms: description: Term IDs. type: array items: type: integer default: [] additionalProperties: false - name: sticky in: query required: false description: Limit result set to items that are sticky. schema: type: boolean - name: ignore_sticky in: query required: false description: Whether to ignore sticky posts or not. schema: type: boolean default: true - name: format in: query required: false description: Limit result set to items assigned one or more given formats. schema: type: array items: enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_posts summary: POST /wp/v2/posts tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/posts/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_posts_id summary: GET /wp/v2/posts/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_posts_id summary: POST /wp/v2/posts/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_posts_id summary: PUT /wp/v2/posts/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_posts_id summary: PATCH /wp/v2/posts/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_posts_id summary: DELETE /wp/v2/posts/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/posts/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_posts_id_autosaves summary: GET /wp/v2/posts/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_posts_id_autosaves summary: POST /wp/v2/posts/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the autosave. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. author: type: integer description: The ID for the author of the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true 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 properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/posts/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_posts_parent_autosaves_id summary: GET /wp/v2/posts/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/posts/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_posts_parent_revisions summary: GET /wp/v2/posts/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/posts/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_posts_parent_revisions_id summary: GET /wp/v2/posts/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_posts_parent_revisions_id summary: DELETE /wp/v2/posts/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/products: get: operationId: get_wp_v2_products summary: GET /wp/v2/products tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: after in: query required: false description: Limit response to posts published after a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_after in: query required: false description: Limit response to posts modified after a given ISO8601 compliant date. schema: type: string format: date-time - name: before in: query required: false description: Limit response to posts published before a given ISO8601 compliant date. schema: type: string format: date-time - name: modified_before in: query required: false description: Limit response to posts modified before a given ISO8601 compliant date. schema: type: string format: date-time - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: menu_order in: query required: false description: Limit result set to posts with a specific menu_order value. schema: type: integer - name: search_semantics in: query required: false description: How to interpret the search input. schema: type: string enum: - exact - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array default: [] items: type: integer - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array default: [] items: type: integer - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - post_title - post_content - post_excerpt type: string - name: slug in: query required: false description: Limit result set to posts with one or more specific slugs. schema: type: array items: type: string - name: status in: query required: false description: Limit result set to posts assigned one or more statuses. schema: type: array default: publish items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - spam - jp-temp-feedback - any type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_products summary: POST /wp/v2/products tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/products/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_products_id summary: GET /wp/v2/products/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: excerpt_length in: query required: false description: Override the default excerpt length. schema: type: integer - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_products_id summary: POST /wp/v2/products/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_products_id summary: PUT /wp/v2/products/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_products_id summary: PATCH /wp/v2/products/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam 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 properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_products_id summary: DELETE /wp/v2/products/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Product' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/products/{id}/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_products_id_autosaves summary: GET /wp/v2/products/{id}/autosaves tags: - wp/v2 parameters: - name: parent in: query required: false description: The ID for the parent of the autosave. schema: type: integer - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_products_id_autosaves summary: POST /wp/v2/products/{id}/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: parent: type: integer description: The ID for the parent of the post. date: type: - string - 'null' format: date-time description: The date the post was published, in the site's timezone. date_gmt: type: - string - 'null' 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. title: type: object properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true description: The title for the post. content: type: object properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The content for the post. excerpt: type: object properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true description: The excerpt for the post. featured_media: type: integer description: The ID of the featured media for the post. menu_order: type: integer description: The order of the post in relation to other posts. meta: type: object properties: footnotes: type: string title: '' description: '' default: '' description: Meta fields. template: type: string description: The theme file to use to display the post. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/products/{parent}/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_products_parent_autosaves_id summary: GET /wp/v2/products/{parent}/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/products/{parent}/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_products_parent_revisions summary: GET /wp/v2/products/{parent}/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/products/{parent}/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_products_parent_revisions_id summary: GET /wp/v2/products/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_products_parent_revisions_id summary: DELETE /wp/v2/products/{parent}/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/search: get: operationId: get_wp_v2_search summary: GET /wp/v2/search tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: type in: query required: false description: Limit results to items of an object type. schema: type: string enum: - post - term - post-format default: post - name: subtype in: query required: false description: Limit results to items of one or more object subtypes. schema: type: array default: any items: enum: - post - page - product - brand - category - post_tag - any type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/settings: get: operationId: get_wp_v2_settings summary: GET /wp/v2/settings tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_settings summary: POST /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: jetpack_ai_agents_enabled: type: boolean description: Whether AI Agent Access is enabled on this site. wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. title: type: string description: Site title. description: type: string description: Site tagline. 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. jetpack_search_ai_behavior_instructions: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object properties: id: type: string format: text-field name: type: string format: text-field icon: type: string format: uri url: type: string format: uri description: type: string format: text-field is_non_wpcom_site: type: boolean additionalProperties: false description: Site Recommendations responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_settings summary: PUT /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: jetpack_ai_agents_enabled: type: boolean description: Whether AI Agent Access is enabled on this site. wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. title: type: string description: Site title. description: type: string description: Site tagline. 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. jetpack_search_ai_behavior_instructions: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object properties: id: type: string format: text-field name: type: string format: text-field icon: type: string format: uri url: type: string format: uri description: type: string format: text-field is_non_wpcom_site: type: boolean additionalProperties: false description: Site Recommendations responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_settings summary: PATCH /wp/v2/settings tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: jetpack_ai_agents_enabled: type: boolean description: Whether AI Agent Access is enabled on this site. wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. title: type: string description: Site title. description: type: string description: Site tagline. 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. jetpack_search_ai_behavior_instructions: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object properties: id: type: string format: text-field name: type: string format: text-field icon: type: string format: uri url: type: string format: uri description: type: string format: text-field is_non_wpcom_site: type: boolean additionalProperties: false description: Site Recommendations responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/sidebars: get: operationId: get_wp_v2_sidebars summary: GET /wp/v2/sidebars tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/sidebars/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_sidebars_id summary: GET /wp/v2/sidebars/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_sidebars_id summary: POST /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_sidebars_id summary: PUT /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_sidebars_id summary: PATCH /wp/v2/sidebars/{id} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/statuses: get: operationId: get_wp_v2_statuses summary: GET /wp/v2/statuses tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/statuses/{status}: parameters: - name: status in: path required: true schema: type: string get: operationId: get_wp_v2_statuses_status summary: GET /wp/v2/statuses/{status} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/tags: get: operationId: get_wp_v2_tags summary: GET /wp/v2/tags tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name - name: hide_empty in: query required: false description: Whether to hide terms not assigned to any posts. schema: type: boolean default: false - name: post in: query required: false description: Limit result set to terms assigned to a specific post. schema: type: integer default: null - name: slug in: query required: false description: Limit result set to terms with one or more specific slugs. schema: type: array items: type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_tags summary: POST /wp/v2/tags tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. required: - name responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/tags/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_tags_id summary: GET /wp/v2/tags/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_tags_id summary: POST /wp/v2/tags/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_tags_id summary: PUT /wp/v2/tags/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_tags_id summary: PATCH /wp/v2/tags/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_tags_id summary: DELETE /wp/v2/tags/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as terms do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/taxonomies: get: operationId: get_wp_v2_taxonomies summary: GET /wp/v2/taxonomies tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: type in: query required: false description: Limit results to taxonomies associated with a specific post type. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/taxonomies/{taxonomy}: parameters: - name: taxonomy in: path required: true schema: type: string get: operationId: get_wp_v2_taxonomies_taxonomy summary: GET /wp/v2/taxonomies/{taxonomy} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts: get: operationId: get_wp_v2_template_parts summary: GET /wp/v2/template-parts tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: wp_id in: query required: false description: Limit to the specified post id. schema: type: integer - name: area in: query required: false description: Limit to the specified template part area. schema: type: string - name: post_type in: query required: false description: Post type to get the templates for. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_template_parts summary: POST /wp/v2/template-parts tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string default: '' properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string default: '' properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam default: publish 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/template-parts/{id}?)[\/\w%-]+): parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_template_parts_id_w summary: GET /wp/v2/template-parts/{id}?)[\/\w%-]+) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_template_parts_id_w summary: POST /wp/v2/template-parts/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_template_parts_id_w summary: PUT /wp/v2/template-parts/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_template_parts_id_w summary: PATCH /wp/v2/template-parts/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_template_parts_id_w summary: DELETE /wp/v2/template-parts/{id}?)[\/\w%-]+) tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/template-parts/{id}?)[\/\w%-]+)/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_template_parts_id_w_autosaves summary: GET /wp/v2/template-parts/{id}?)[\/\w%-]+)/autosaves tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_template_parts_id_w_autosaves summary: POST /wp/v2/template-parts/{id}?)[\/\w%-]+)/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam 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.) responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/template-parts/{parent}?)[\/\w%-]+)/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_template_parts_parent_w_autosaves_id summary: GET /wp/v2/template-parts/{parent}?)[\/\w%-]+)/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts/{parent}?)[\/\w%-]+)/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_template_parts_parent_w_revisions summary: GET /wp/v2/template-parts/{parent}?)[\/\w%-]+)/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts/{parent}?)[\/\w%-]+)/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_template_parts_parent_w_revisions_id summary: GET /wp/v2/template-parts/{parent}?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_template_parts_parent_w_revisions_id summary: DELETE /wp/v2/template-parts/{parent}?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/template-parts/lookup: get: operationId: get_wp_v2_template_parts_lookup summary: GET /wp/v2/template-parts/lookup tags: - wp/v2 parameters: - name: slug in: query required: true description: The slug of the template to get the fallback for schema: type: string - name: is_custom in: query required: false description: Indicates if a template is custom or part of the template hierarchy schema: type: boolean - name: template_prefix in: query required: false 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` schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates: get: operationId: get_wp_v2_templates summary: GET /wp/v2/templates tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: wp_id in: query required: false description: Limit to the specified post id. schema: type: integer - name: area in: query required: false description: Limit to the specified template part area. schema: type: string - name: post_type in: query required: false description: Post type to get the templates for. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_templates summary: POST /wp/v2/templates tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string default: '' properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string default: '' properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam default: publish description: Status of template. author: type: integer description: The ID for the author of the template. required: - slug responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/templates/{id}?)[\/\w%-]+): parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_templates_id_w summary: GET /wp/v2/templates/{id}?)[\/\w%-]+) tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_templates_id_w summary: POST /wp/v2/templates/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_templates_id_w summary: PUT /wp/v2/templates/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_templates_id_w summary: PATCH /wp/v2/templates/{id}?)[\/\w%-]+) tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_templates_id_w summary: DELETE /wp/v2/templates/{id}?)[\/\w%-]+) tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/templates/{id}?)[\/\w%-]+)/autosaves: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_templates_id_w_autosaves summary: GET /wp/v2/templates/{id}?)[\/\w%-]+)/autosaves tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_templates_id_w_autosaves summary: POST /wp/v2/templates/{id}?)[\/\w%-]+)/autosaves tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: slug: type: string pattern: '[a-zA-Z0-9_\%-]+' 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 - string properties: raw: description: Content for the template, as it exists in the database. type: string context: - view - edit block_version: description: Version of the content block format used by the template. type: integer context: - edit readonly: true description: Content of template. title: type: - object - string properties: raw: description: Title for the template, as it exists in the database. type: string context: - view - edit - embed rendered: description: HTML title for the template, transformed for display. type: string context: - view - edit - embed readonly: true description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/templates/{parent}?)[\/\w%-]+)/autosaves/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_templates_parent_w_autosaves_id summary: GET /wp/v2/templates/{parent}?)[\/\w%-]+)/autosaves/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates/{parent}?)[\/\w%-]+)/revisions: parameters: - name: parent in: path required: true schema: type: string get: operationId: get_wp_v2_templates_parent_w_revisions summary: GET /wp/v2/templates/{parent}?)[\/\w%-]+)/revisions tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates/{parent}?)[\/\w%-]+)/revisions/{id}: parameters: - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_templates_parent_w_revisions_id summary: GET /wp/v2/templates/{parent}?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: delete_wp_v2_templates_parent_w_revisions_id summary: DELETE /wp/v2/templates/{parent}?)[\/\w%-]+)/revisions/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as revisions do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/templates/lookup: get: operationId: get_wp_v2_templates_lookup summary: GET /wp/v2/templates/lookup tags: - wp/v2 parameters: - name: slug in: query required: true description: The slug of the template to get the fallback for schema: type: string - name: is_custom in: query required: false description: Indicates if a template is custom or part of the template hierarchy schema: type: boolean - name: template_prefix in: query required: false 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` schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/themes: get: operationId: get_wp_v2_themes summary: GET /wp/v2/themes tags: - wp/v2 parameters: - name: status in: query required: false description: Limit result set to themes assigned one or more statuses. schema: type: array items: enum: - active - inactive type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/themes/{stylesheet}?): parameters: - name: stylesheet in: path required: true schema: type: string get: operationId: get_wp_v2_themes_stylesheet summary: GET /wp/v2/themes/{stylesheet}?) tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/types: get: operationId: get_wp_v2_types summary: GET /wp/v2/types tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/types/{type}: parameters: - name: type in: path required: true schema: type: string get: operationId: get_wp_v2_types_type summary: GET /wp/v2/types/{type} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/users: get: operationId: get_wp_v2_users summary: GET /wp/v2/users tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by user attribute. schema: type: string enum: - id - include - name - registered_date - slug - include_slugs - email - url default: name - name: slug in: query required: false description: Limit result set to users with one or more specific slugs. schema: type: array items: type: string - name: roles in: query required: false description: Limit result set to users matching at least one specific role provided. Accepts csv list or single role. schema: type: array items: type: string - name: capabilities in: query required: false description: Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability. schema: type: array items: type: string - name: who in: query required: false description: Limit result set to users who are considered authors. schema: type: string enum: - authors - name: has_published_posts in: query required: false description: Limit result set to users who have published posts. schema: type: - boolean - array items: type: string enum: post: post page: page attachment: attachment nav_menu_item: nav_menu_item wp_block: wp_block wp_template: wp_template wp_template_part: wp_template_part wp_global_styles: wp_global_styles wp_navigation: wp_navigation wp_font_family: wp_font_family wp_font_face: wp_font_face jp_search_overlay: jp_search_overlay feedback: feedback jetpack_form: jetpack_form product: product brand: brand jp_act_log_event: jp_act_log_event jp_pay_order: jp_pay_order jp_pay_product: jp_pay_product - name: search_columns in: query required: false description: Array of column names to be searched. schema: type: array default: [] items: enum: - email - name - id - username - slug type: string responses: '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_users summary: POST /wp/v2/users tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. required: - username - email - password responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/users/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_users_id summary: GET /wp/v2/users/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_users_id summary: POST /wp/v2/users/{id} tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_users_id summary: PUT /wp/v2/users/{id} tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_users_id summary: PATCH /wp/v2/users/{id} tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_users_id summary: DELETE /wp/v2/users/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as users do not support trashing. schema: type: boolean default: false - name: reassign in: query required: true description: Reassign the deleted user's posts and links to this user ID. schema: type: integer responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/users/{user_id})/application-passwords: parameters: - name: user_id in: path required: true schema: type: integer get: operationId: get_wp_v2_users_user_id_application_passwords summary: GET /wp/v2/users/{user_id})/application-passwords tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_users_user_id_application_passwords summary: POST /wp/v2/users/{user_id})/application-passwords tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string oneOf: - type: string format: uuid - type: string enum: - '' 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 pattern: .*\S.* description: The name of the application password. required: - name responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_users_user_id_application_passwords summary: DELETE /wp/v2/users/{user_id})/application-passwords tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/users/{user_id})/application-passwords/{uuid}: parameters: - name: user_id in: path required: true schema: type: integer - name: uuid in: path required: true schema: type: integer get: operationId: get_wp_v2_users_user_id_application_passwords_uuid summary: GET /wp/v2/users/{user_id})/application-passwords/{uuid} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_users_user_id_application_passwords_uuid summary: POST /wp/v2/users/{user_id})/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string oneOf: - type: string format: uuid - type: string enum: - '' 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 pattern: .*\S.* description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_users_user_id_application_passwords_uuid summary: PUT /wp/v2/users/{user_id})/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string oneOf: - type: string format: uuid - type: string enum: - '' 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 pattern: .*\S.* description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_users_user_id_application_passwords_uuid summary: PATCH /wp/v2/users/{user_id})/application-passwords/{uuid} tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: app_id: type: string oneOf: - type: string format: uuid - type: string enum: - '' 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 pattern: .*\S.* description: The name of the application password. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_users_user_id_application_passwords_uuid summary: DELETE /wp/v2/users/{user_id})/application-passwords/{uuid} tags: - wp/v2 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/users/{user_id})/application-passwords/introspect: parameters: - name: user_id in: path required: true schema: type: integer get: operationId: get_wp_v2_users_user_id_application_passwords_introspect summary: GET /wp/v2/users/{user_id})/application-passwords/introspect tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/users/me: get: operationId: get_wp_v2_users_me summary: GET /wp/v2/users/me tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_users_me summary: POST /wp/v2/users/me tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_users_me summary: PUT /wp/v2/users/me tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_users_me summary: PATCH /wp/v2/users/me tags: - wp/v2 requestBody: required: false 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 properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false description: Meta fields. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_users_me summary: DELETE /wp/v2/users/me tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as users do not support trashing. schema: type: boolean default: false - name: reassign in: query required: true description: Reassign the deleted user's posts and links to this user ID. schema: type: integer responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/view-config: get: operationId: get_wp_v2_view_config summary: GET /wp/v2/view-config tags: - wp/v2 parameters: - name: kind in: query required: true description: Entity kind. schema: type: string - name: name in: query required: true description: Entity name. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/widget-types: get: operationId: get_wp_v2_widget_types summary: GET /wp/v2/widget-types tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/widget-types/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_widget_types_id summary: GET /wp/v2/widget-types/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/widget-types/{id}/encode: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_widget_types_id_encode summary: POST /wp/v2/widget-types/{id}/encode tags: - wp/v2 requestBody: required: false 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/widget-types/{id}/render: parameters: - name: id in: path required: true schema: type: integer post: operationId: post_wp_v2_widget_types_id_render summary: POST /wp/v2/widget-types/{id}/render tags: - wp/v2 requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/widgets: get: operationId: get_wp_v2_widgets summary: GET /wp/v2/widgets tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: sidebar in: query required: false description: The sidebar to return widgets for. schema: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_widgets summary: POST /wp/v2/widgets tags: - wp/v2 requestBody: required: false 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 properties: encoded: description: Base64 encoded representation of the instance settings. type: string context: - edit hash: description: Cryptographic hash of the instance settings. type: string context: - edit raw: description: Unencoded instance settings, if supported. type: object context: - edit 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 responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/widgets/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_widgets_id summary: GET /wp/v2/widgets/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_widgets_id summary: POST /wp/v2/widgets/{id} tags: - wp/v2 requestBody: required: false 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 properties: encoded: description: Base64 encoded representation of the instance settings. type: string context: - edit hash: description: Cryptographic hash of the instance settings. type: string context: - edit raw: description: Unencoded instance settings, if supported. type: object context: - edit 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_widgets_id summary: PUT /wp/v2/widgets/{id} tags: - wp/v2 requestBody: required: false 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 properties: encoded: description: Base64 encoded representation of the instance settings. type: string context: - edit hash: description: Cryptographic hash of the instance settings. type: string context: - edit raw: description: Unencoded instance settings, if supported. type: object context: - edit 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_widgets_id summary: PATCH /wp/v2/widgets/{id} tags: - wp/v2 requestBody: required: false 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 properties: encoded: description: Base64 encoded representation of the instance settings. type: string context: - edit hash: description: Cryptographic hash of the instance settings. type: string context: - edit raw: description: Unencoded instance settings, if supported. type: object context: - edit 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. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_widgets_id summary: DELETE /wp/v2/widgets/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Whether to force removal of the widget, or move it to the inactive sidebar. schema: type: boolean responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/wp_pattern_category: get: operationId: get_wp_v2_wp_pattern_category summary: GET /wp/v2/wp_pattern_category tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view - name: page in: query required: false description: Current page of the collection. schema: type: integer default: 1 minimum: 1 - name: per_page in: query required: false description: Maximum number of items to be returned in result set. schema: type: integer default: 10 minimum: 1 maximum: 100 - name: search in: query required: false description: Limit results to those matching a string. schema: type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array default: [] items: type: integer - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array default: [] items: type: integer - name: offset in: query required: false description: Offset the result set by a specific number of items. schema: type: integer - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string enum: - asc - desc default: asc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name - name: hide_empty in: query required: false description: Whether to hide terms not assigned to any posts. schema: type: boolean default: false - name: post in: query required: false description: Limit result set to terms assigned to a specific post. schema: type: integer default: null - name: slug in: query required: false description: Limit result set to terms with one or more specific slugs. schema: type: array items: type: string responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_wp_pattern_category summary: POST /wp/v2/wp_pattern_category tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. required: - name responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] /wp/v2/wp_pattern_category/{id}: parameters: - name: id in: path required: true schema: type: integer get: operationId: get_wp_v2_wp_pattern_category_id summary: GET /wp/v2/wp_pattern_category/{id} tags: - wp/v2 parameters: - name: context in: query required: false description: Scope under which the request is made; determines fields present in response. schema: type: string enum: - view - embed - edit default: view responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: post_wp_v2_wp_pattern_category_id summary: POST /wp/v2/wp_pattern_category/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] put: operationId: put_wp_v2_wp_pattern_category_id summary: PUT /wp/v2/wp_pattern_category/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] patch: operationId: patch_wp_v2_wp_pattern_category_id summary: PATCH /wp/v2/wp_pattern_category/{id} tags: - wp/v2 requestBody: required: false 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 properties: [] description: Meta fields. responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] delete: operationId: delete_wp_v2_wp_pattern_category_id summary: DELETE /wp/v2/wp_pattern_category/{id} tags: - wp/v2 parameters: - name: force in: query required: false description: Required to be true, as terms do not support trashing. schema: type: boolean default: false responses: '200': description: Success content: application/json: schema: type: object '400': description: Invalid parameter content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required for this operation content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource found content: application/json: schema: $ref: '#/components/schemas/RestError' security: - applicationPassword: [] components: schemas: Post: $schema: http://json-schema.org/draft-04/schema# title: post type: object properties: date: description: The date the post was published, in the site's timezone. type: - string - 'null' format: date-time context: - view - edit - embed date_gmt: description: The date the post was published, as GMT. type: - string - 'null' format: date-time context: - view - edit guid: description: The globally unique identifier for the post. type: object context: - view - edit readonly: true properties: raw: description: GUID for the post, as it exists in the database. type: string context: - edit readonly: true rendered: description: GUID for the post, transformed for display. type: string context: - view - edit readonly: true id: description: Unique identifier for the post. type: integer context: - view - edit - embed readonly: true link: description: URL to the post. type: string format: uri context: - view - edit - embed readonly: true modified: description: The date the post was last modified, in the site's timezone. type: string format: date-time context: - view - edit readonly: true modified_gmt: description: The date the post was last modified, as GMT. type: string format: date-time context: - view - edit readonly: true slug: description: An alphanumeric identifier for the post unique to its type. type: string context: - view - edit - embed status: description: A named status for the post. type: string enum: - publish - future - draft - pending - private - spam context: - view - edit type: description: Type of post. type: string context: - view - edit - embed readonly: true password: description: A password to protect access to the content and excerpt. type: string context: - edit permalink_template: description: Permalink template for the post. type: string context: - edit readonly: true generated_slug: description: Slug automatically generated from the post title. type: string context: - edit readonly: true class_list: description: An array of the class names for the post container element. type: array context: - view - edit readonly: true items: type: string title: description: The title for the post. type: object context: - view - edit - embed properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true content: description: The content for the post. type: object context: - view - edit properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true author: description: The ID for the author of the post. type: integer context: - view - edit - embed excerpt: description: The excerpt for the post. type: object context: - view - edit - embed properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true featured_media: description: The ID of the featured media for the post. type: integer context: - view - edit - embed comment_status: description: Whether or not comments are open on the post. type: string enum: - open - closed context: - view - edit ping_status: description: Whether or not the post can be pinged. type: string enum: - open - closed context: - view - edit format: description: The format for the post. type: string enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: _yoast_wpseo_focuskw: type: string title: '' description: '' default: '' _yoast_wpseo_title: type: string title: '' description: '' default: '' _yoast_wpseo_metadesc: type: string title: '' description: '' default: '' _jetpack_newsletter_access: type: string title: '' description: '' default: '' _jetpack_dont_email_post_to_subs: type: boolean title: '' description: '' default: false _jetpack_newsletter_tier_id: type: integer title: '' description: '' default: 0 _jetpack_memberships_contains_paywalled_content: type: boolean title: '' description: '' default: false agcorp_lede: type: string title: '' description: '' default: '' _jetpack_feature_clip_id: type: integer title: '' description: Attachment ID of the generated video clip designated as this post's feature clip. default: 0 _jetpack_memberships_contains_paid_content: type: boolean title: '' description: '' default: false footnotes: type: string title: '' description: '' default: '' jetpack_post_was_ever_published: type: boolean title: '' description: Whether the post was ever published. default: false sticky: description: Whether or not the post should be treated as sticky. type: boolean context: - view - edit template: description: The theme file to use to display the post. type: string context: - view - edit categories: description: The terms assigned to the post in the category taxonomy. type: array items: type: integer context: - view - edit tags: description: The terms assigned to the post in the post_tag taxonomy. type: array items: type: integer context: - view - edit jetpack_sharing_enabled: description: Are sharing buttons enabled? type: boolean links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: status: type: string enum: - publish - future - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: content: raw: type: string - rel: https://api.w.org/action-sticky title: The current user can sticky this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: sticky: type: boolean - rel: https://api.w.org/action-assign-author title: The current user can change the author on this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: author: type: integer - rel: https://api.w.org/action-assign-categories title: The current user can assign terms in the category taxonomy. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: categories: type: array items: type: integer - rel: https://api.w.org/action-create-categories title: The current user can create terms in the category taxonomy. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: categories: type: array items: type: integer - rel: https://api.w.org/action-assign-tags title: The current user can assign terms in the post_tag taxonomy. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: tags: type: array items: type: integer - rel: https://api.w.org/action-create-tags title: The current user can create terms in the post_tag taxonomy. href: https://corporate.americangreetings.com/wp-json/wp/v2/posts/{id} targetSchema: type: object properties: tags: type: array items: type: integer Page: $schema: http://json-schema.org/draft-04/schema# title: page type: object properties: date: description: The date the post was published, in the site's timezone. type: - string - 'null' format: date-time context: - view - edit - embed date_gmt: description: The date the post was published, as GMT. type: - string - 'null' format: date-time context: - view - edit guid: description: The globally unique identifier for the post. type: object context: - view - edit readonly: true properties: raw: description: GUID for the post, as it exists in the database. type: string context: - edit readonly: true rendered: description: GUID for the post, transformed for display. type: string context: - view - edit readonly: true id: description: Unique identifier for the post. type: integer context: - view - edit - embed readonly: true link: description: URL to the post. type: string format: uri context: - view - edit - embed readonly: true modified: description: The date the post was last modified, in the site's timezone. type: string format: date-time context: - view - edit readonly: true modified_gmt: description: The date the post was last modified, as GMT. type: string format: date-time context: - view - edit readonly: true slug: description: An alphanumeric identifier for the post unique to its type. type: string context: - view - edit - embed status: description: A named status for the post. type: string enum: - publish - future - draft - pending - private - spam context: - view - edit type: description: Type of post. type: string context: - view - edit - embed readonly: true password: description: A password to protect access to the content and excerpt. type: string context: - edit permalink_template: description: Permalink template for the post. type: string context: - edit readonly: true generated_slug: description: Slug automatically generated from the post title. type: string context: - edit readonly: true class_list: description: An array of the class names for the post container element. type: array context: - view - edit readonly: true items: type: string parent: description: The ID for the parent of the post. type: integer context: - view - edit title: description: The title for the post. type: object context: - view - edit - embed properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true content: description: The content for the post. type: object context: - view - edit properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true author: description: The ID for the author of the post. type: integer context: - view - edit - embed excerpt: description: The excerpt for the post. type: object context: - view - edit - embed properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true featured_media: description: The ID of the featured media for the post. type: integer context: - view - edit - embed comment_status: description: Whether or not comments are open on the post. type: string enum: - open - closed context: - view - edit ping_status: description: Whether or not the post can be pinged. type: string enum: - open - closed context: - view - edit menu_order: description: The order of the post in relation to other posts. type: integer context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: footnotes: type: string title: '' description: '' default: '' template: description: The theme file to use to display the post. type: string context: - view - edit jetpack_sharing_enabled: description: Are sharing buttons enabled? type: boolean links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/pages/{id} targetSchema: type: object properties: status: type: string enum: - publish - future - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://corporate.americangreetings.com/wp-json/wp/v2/pages/{id} targetSchema: type: object properties: content: raw: type: string - rel: https://api.w.org/action-assign-author title: The current user can change the author on this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/pages/{id} targetSchema: type: object properties: author: type: integer Attachment: $schema: http://json-schema.org/draft-04/schema# title: attachment type: object properties: date: description: The date the post was published, in the site's timezone. type: - string - 'null' format: date-time context: - view - edit - embed date_gmt: description: The date the post was published, as GMT. type: - string - 'null' format: date-time context: - view - edit guid: description: The globally unique identifier for the post. type: object context: - view - edit readonly: true properties: raw: description: GUID for the post, as it exists in the database. type: string context: - edit readonly: true rendered: description: GUID for the post, transformed for display. type: string context: - view - edit readonly: true id: description: Unique identifier for the post. type: integer context: - view - edit - embed readonly: true link: description: URL to the post. type: string format: uri context: - view - edit - embed readonly: true modified: description: The date the post was last modified, in the site's timezone. type: string format: date-time context: - view - edit readonly: true modified_gmt: description: The date the post was last modified, as GMT. type: string format: date-time context: - view - edit readonly: true slug: description: An alphanumeric identifier for the post unique to its type. type: string context: - view - edit - embed status: description: A named status for the post. type: string enum: - publish - future - draft - pending - private - spam context: - view - edit type: description: Type of post. type: string context: - view - edit - embed readonly: true permalink_template: description: Permalink template for the post. type: string context: - edit readonly: true generated_slug: description: Slug automatically generated from the post title. type: string context: - edit readonly: true class_list: description: An array of the class names for the post container element. type: array context: - view - edit readonly: true items: type: string title: description: The title for the post. type: object context: - view - edit - embed properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true author: description: The ID for the author of the post. type: integer context: - view - edit - embed featured_media: description: The ID of the featured media for the post. type: integer context: - view - edit - embed comment_status: description: Whether or not comments are open on the post. type: string enum: - open - closed context: - view - edit ping_status: description: Whether or not the post can be pinged. type: string enum: - open - closed context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: [] template: description: The theme file to use to display the post. type: string context: - view - edit jetpack_sharing_enabled: description: Are sharing buttons enabled? type: boolean jetpack_videopress_guid: $schema: http://json-schema.org/draft-04/schema# title: jetpack_videopress_guid type: string context: - view - edit readonly: true description: Unique VideoPress ID jetpack_videopress: $schema: http://json-schema.org/draft-04/schema# title: jetpack_videopress type: object context: - view - edit readonly: true description: VideoPress Data alt_text: description: Alternative text to display when attachment is not displayed. type: string context: - view - edit - embed caption: description: The attachment caption. type: object context: - view - edit - embed properties: raw: description: Caption for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML caption for the attachment, transformed for display. type: string context: - view - edit - embed readonly: true description: description: The attachment description. type: object context: - view - edit properties: raw: description: Description for the attachment, as it exists in the database. type: string context: - edit rendered: description: HTML description for the attachment, transformed for display. type: string context: - view - edit readonly: true media_type: description: Attachment type. type: string enum: - image - file context: - view - edit - embed readonly: true mime_type: description: The attachment MIME type. type: string context: - view - edit - embed readonly: true media_details: description: Details about the media file, specific to its type. type: object context: - view - edit - embed readonly: true post: description: The ID for the associated post of the attachment. type: integer context: - view - edit source_url: description: URL to the original attachment file. type: string format: uri context: - view - edit - embed readonly: true missing_image_sizes: description: List of the missing image sizes of the attachment. type: array items: type: string context: - edit readonly: true filename: description: Original attachment file name. type: string context: - view - edit readonly: true filesize: description: Attachment file size in bytes. type: - integer - 'null' context: - view - edit readonly: true exif_orientation: description: EXIF orientation value. Values 1-8 follow the EXIF specification, where 1 means no rotation needed. type: integer context: - edit readonly: true image_quality: description: Encode quality (1-100) from the wp_editor_set_quality filter, resolved against the output MIME type. The "default" value applies to the full-size image; "sizes" lists per-registered-size overrides where the filtered value differs from "default". type: object context: - edit readonly: true properties: default: type: integer minimum: 1 maximum: 100 sizes: type: object properties: [] image_output_format: description: The output MIME type this image should be converted to, based on the image_editor_output_format filter. Null if no conversion is needed. type: - string - 'null' context: - edit readonly: true image_save_progressive: description: Whether to use progressive/interlaced encoding when saving this image. type: boolean context: - edit readonly: true links: - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://corporate.americangreetings.com/wp-json/wp/v2/media/{id} targetSchema: type: object properties: content: raw: type: string - rel: https://api.w.org/action-assign-author title: The current user can change the author on this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/media/{id} targetSchema: type: object properties: author: type: integer Category: $schema: http://json-schema.org/draft-04/schema# title: category type: object properties: id: description: Unique identifier for the term. type: integer context: - view - embed - edit readonly: true count: description: Number of published posts for the term. type: integer context: - view - edit readonly: true description: description: HTML description of the term. type: string context: - view - edit link: description: URL of the term. type: string format: uri context: - view - embed - edit readonly: true name: description: HTML title for the term. type: string context: - view - embed - edit required: true slug: description: An alphanumeric identifier for the term unique to its type. type: string context: - view - embed - edit taxonomy: description: Type attribution for the term. type: string enum: - category context: - view - embed - edit readonly: true parent: description: The parent term ID. type: integer context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: [] Tag: $schema: http://json-schema.org/draft-04/schema# title: tag type: object properties: id: description: Unique identifier for the term. type: integer context: - view - embed - edit readonly: true count: description: Number of published posts for the term. type: integer context: - view - edit readonly: true description: description: HTML description of the term. type: string context: - view - edit link: description: URL of the term. type: string format: uri context: - view - embed - edit readonly: true name: description: HTML title for the term. type: string context: - view - embed - edit required: true slug: description: An alphanumeric identifier for the term unique to its type. type: string context: - view - embed - edit taxonomy: description: Type attribution for the term. type: string enum: - post_tag context: - view - embed - edit readonly: true meta: description: Meta fields. type: object context: - view - edit properties: [] User: $schema: http://json-schema.org/draft-04/schema# title: user type: object properties: id: description: Unique identifier for the user. type: integer context: - embed - view - edit readonly: true username: description: Login name for the user. type: string context: - edit required: true name: description: Display name for the user. type: string context: - embed - view - edit first_name: description: First name for the user. type: string context: - edit last_name: description: Last name for the user. type: string context: - edit email: description: The email address for the user. type: string format: email context: - edit required: true url: description: URL of the user. type: string format: uri context: - embed - view - edit description: description: Description of the user. type: string context: - embed - view - edit link: description: Author URL of the user. type: string format: uri context: - embed - view - edit readonly: true locale: description: Locale for the user. type: string enum: - '' - en_US context: - edit nickname: description: The nickname for the user. type: string context: - edit slug: description: An alphanumeric identifier for the user. type: string context: - embed - view - edit registered_date: description: Registration date for the user. type: string format: date-time context: - edit readonly: true roles: description: Roles assigned to the user. type: array items: type: string context: - edit password: description: Password for the user (never included). type: string context: [] required: true capabilities: description: All capabilities assigned to the user. type: object context: - edit readonly: true extra_capabilities: description: Any extra capabilities assigned to the user. type: object context: - edit readonly: true avatar_urls: description: Avatar URLs for the user. type: object context: - embed - view - edit readonly: true properties: '24': description: Avatar URL with image size of 24 pixels. type: string format: uri context: - embed - view - edit '48': description: Avatar URL with image size of 48 pixels. type: string format: uri context: - embed - view - edit '96': description: Avatar URL with image size of 96 pixels. type: string format: uri context: - embed - view - edit meta: description: Meta fields. type: object context: - view - edit properties: persisted_preferences: type: object title: '' description: '' default: [] context: - edit properties: _modified: description: The date and time the preferences were updated. type: string format: date-time readonly: false additionalProperties: true jetpack_donation_warning_dismissed: type: boolean title: '' description: '' default: false Comment: $schema: http://json-schema.org/draft-04/schema# title: comment type: object properties: id: description: Unique identifier for the comment. type: integer context: - view - edit - embed readonly: true author: description: The ID of the user object, if author was a user. type: integer context: - view - edit - embed author_email: description: Email address for the comment author. type: string format: email context: - edit author_ip: description: IP address for the comment author. type: string format: ip context: - edit author_name: description: Display name for the comment author. type: string context: - view - edit - embed author_url: description: URL for the comment author. type: string format: uri context: - view - edit - embed author_user_agent: description: User agent for the comment author. type: string context: - edit content: description: The content for the comment. type: object context: - view - edit - embed properties: raw: description: Content for the comment, as it exists in the database. type: string context: - edit rendered: description: HTML content for the comment, transformed for display. type: string context: - view - edit - embed readonly: true date: description: The date the comment was published, in the site's timezone. type: string format: date-time context: - view - edit - embed date_gmt: description: The date the comment was published, as GMT. type: string format: date-time context: - view - edit link: description: URL to the comment. type: string format: uri context: - view - edit - embed readonly: true parent: description: The ID for the parent of the comment. type: integer context: - view - edit - embed default: 0 post: description: The ID of the associated post object. type: integer context: - view - edit default: 0 status: description: State of the comment. type: string context: - view - edit type: description: Type of the comment. type: string context: - view - edit - embed readonly: true default: comment author_avatar_urls: description: Avatar URLs for the comment author. type: object context: - view - edit - embed readonly: true properties: '24': description: Avatar URL with image size of 24 pixels. type: string format: uri context: - embed - view - edit '48': description: Avatar URL with image size of 48 pixels. type: string format: uri context: - embed - view - edit '96': description: Avatar URL with image size of 96 pixels. type: string format: uri context: - embed - view - edit meta: description: Meta fields. type: object context: - view - edit properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen Product: $schema: http://json-schema.org/draft-04/schema# title: product type: object properties: date: description: The date the post was published, in the site's timezone. type: - string - 'null' format: date-time context: - view - edit - embed date_gmt: description: The date the post was published, as GMT. type: - string - 'null' format: date-time context: - view - edit guid: description: The globally unique identifier for the post. type: object context: - view - edit readonly: true properties: raw: description: GUID for the post, as it exists in the database. type: string context: - edit readonly: true rendered: description: GUID for the post, transformed for display. type: string context: - view - edit readonly: true id: description: Unique identifier for the post. type: integer context: - view - edit - embed readonly: true link: description: URL to the post. type: string format: uri context: - view - edit - embed readonly: true modified: description: The date the post was last modified, in the site's timezone. type: string format: date-time context: - view - edit readonly: true modified_gmt: description: The date the post was last modified, as GMT. type: string format: date-time context: - view - edit readonly: true slug: description: An alphanumeric identifier for the post unique to its type. type: string context: - view - edit - embed status: description: A named status for the post. type: string enum: - publish - future - draft - pending - private - spam context: - view - edit type: description: Type of post. type: string context: - view - edit - embed readonly: true password: description: A password to protect access to the content and excerpt. type: string context: - edit permalink_template: description: Permalink template for the post. type: string context: - edit readonly: true generated_slug: description: Slug automatically generated from the post title. type: string context: - edit readonly: true class_list: description: An array of the class names for the post container element. type: array context: - view - edit readonly: true items: type: string parent: description: The ID for the parent of the post. type: integer context: - view - edit title: description: The title for the post. type: object context: - view - edit - embed properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true content: description: The content for the post. type: object context: - view - edit properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true excerpt: description: The excerpt for the post. type: object context: - view - edit - embed properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true featured_media: description: The ID of the featured media for the post. type: integer context: - view - edit - embed menu_order: description: The order of the post in relation to other posts. type: integer context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: footnotes: type: string title: '' description: '' default: '' template: description: The theme file to use to display the post. type: string context: - view - edit jetpack_sharing_enabled: description: Are sharing buttons enabled? type: boolean links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/products/{id} targetSchema: type: object properties: status: type: string enum: - publish - future - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://corporate.americangreetings.com/wp-json/wp/v2/products/{id} targetSchema: type: object properties: content: raw: type: string Brand: $schema: http://json-schema.org/draft-04/schema# title: brand type: object properties: date: description: The date the post was published, in the site's timezone. type: - string - 'null' format: date-time context: - view - edit - embed date_gmt: description: The date the post was published, as GMT. type: - string - 'null' format: date-time context: - view - edit guid: description: The globally unique identifier for the post. type: object context: - view - edit readonly: true properties: raw: description: GUID for the post, as it exists in the database. type: string context: - edit readonly: true rendered: description: GUID for the post, transformed for display. type: string context: - view - edit readonly: true id: description: Unique identifier for the post. type: integer context: - view - edit - embed readonly: true link: description: URL to the post. type: string format: uri context: - view - edit - embed readonly: true modified: description: The date the post was last modified, in the site's timezone. type: string format: date-time context: - view - edit readonly: true modified_gmt: description: The date the post was last modified, as GMT. type: string format: date-time context: - view - edit readonly: true slug: description: An alphanumeric identifier for the post unique to its type. type: string context: - view - edit - embed status: description: A named status for the post. type: string enum: - publish - future - draft - pending - private - spam context: - view - edit type: description: Type of post. type: string context: - view - edit - embed readonly: true password: description: A password to protect access to the content and excerpt. type: string context: - edit permalink_template: description: Permalink template for the post. type: string context: - edit readonly: true generated_slug: description: Slug automatically generated from the post title. type: string context: - edit readonly: true class_list: description: An array of the class names for the post container element. type: array context: - view - edit readonly: true items: type: string parent: description: The ID for the parent of the post. type: integer context: - view - edit title: description: The title for the post. type: object context: - view - edit - embed properties: raw: description: Title for the post, as it exists in the database. type: string context: - edit rendered: description: HTML title for the post, transformed for display. type: string context: - view - edit - embed readonly: true content: description: The content for the post. type: object context: - view - edit properties: raw: description: Content for the post, as it exists in the database. type: string context: - edit rendered: description: HTML content for the post, transformed for display. type: string context: - view - edit readonly: true block_version: description: Version of the content block format used by the post. type: integer context: - edit readonly: true protected: description: Whether the content is protected with a password. type: boolean context: - view - edit - embed readonly: true excerpt: description: The excerpt for the post. type: object context: - view - edit - embed properties: raw: description: Excerpt for the post, as it exists in the database. type: string context: - edit rendered: description: HTML excerpt for the post, transformed for display. type: string context: - view - edit - embed readonly: true protected: description: Whether the excerpt is protected with a password. type: boolean context: - view - edit - embed readonly: true featured_media: description: The ID of the featured media for the post. type: integer context: - view - edit - embed menu_order: description: The order of the post in relation to other posts. type: integer context: - view - edit meta: description: Meta fields. type: object context: - view - edit properties: footnotes: type: string title: '' description: '' default: '' template: description: The theme file to use to display the post. type: string context: - view - edit jetpack_sharing_enabled: description: Are sharing buttons enabled? type: boolean links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://corporate.americangreetings.com/wp-json/wp/v2/brands/{id} targetSchema: type: object properties: status: type: string enum: - publish - future - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://corporate.americangreetings.com/wp-json/wp/v2/brands/{id} targetSchema: type: object properties: content: raw: type: string RestError: type: object description: WordPress REST API error envelope, observed on this host. properties: code: type: string description: Machine-readable error code, e.g. rest_no_route. message: type: string description: Human-readable error message. data: type: object properties: status: type: integer required: - code - message securitySchemes: applicationPassword: type: http scheme: basic description: WordPress application passwords. Authorization endpoint advertised by the provider at https://corporate.americangreetings.com/wp-admin/authorize-application.php security: []