# Derived by the API Evangelist enrichment pipeline from the WordPress REST # API's own route index and OPTIONS item schemas. See info.x-derived-from. openapi: 3.1.0 info: title: Starfish Space Website Content API (WordPress REST v2) version: '2' description: 'The public WordPress REST API served by Starfish Space at https://www.starfishspace.com/wp-json/wp/v2. Starfish Space is a Tukwila, Washington satellite-servicing company building the Otter spacecraft; this API is the content interface behind starfishspace.com (news/press releases, pages, media, taxonomies), not a spacecraft, telemetry or mission-data API. Read operations are available anonymously; write operations require an authenticated WordPress user. This document was DERIVED by API Evangelist from documents the API itself publishes: the machine-readable route index at /wp-json/wp/v2 and the item JSON Schemas returned by HTTP OPTIONS on each collection route. No paths, parameters or schema properties were invented.' contact: name: Starfish Space url: https://www.starfishspace.com/contact/ x-derived-from: - https://www.starfishspace.com/wp-json/wp/v2 - https://www.starfishspace.com/wp-json/wp/v2/{resource} (HTTP OPTIONS) servers: - url: https://www.starfishspace.com/wp-json description: Production tags: - name: block-directory description: Block directory search. - name: block-patterns description: Registered block patterns. - name: block-renderer description: block-renderer routes. - name: block-types description: Registered block types. - name: blocks description: Reusable editor blocks. - name: categories description: Post categories. - name: comments description: Comments on site content. - name: font-collections description: font-collections routes. - name: font-families description: Registered font families. - name: global-styles description: Global styles. - name: icons description: icons routes. - name: media description: Media library attachments (images, documents). - name: menu-items description: Navigation menu items. - name: menu-locations description: Theme menu locations. - name: menus description: Navigation menus. - name: navigation description: Navigation menus. - name: pages description: Static pages (The Otter, Company, Missions, Careers, Contact). - name: pattern-directory description: Pattern directory. - name: plugins description: Installed plugins. - name: posts description: Blog/news posts published on starfishspace.com. - name: search description: Cross-content search. - name: settings description: Site settings. - name: sidebars description: Widget areas. - name: statuses description: Registered post statuses. - name: tags description: Post tags. - name: taxonomies description: Registered taxonomies. - name: template-parts description: Block theme template parts. - name: templates description: Block theme templates. - name: themes description: Installed themes. - name: types description: Registered content types. - name: users description: Site authors. - name: widget-types description: Available widget types. - name: widgets description: Widgets. - name: wp_pattern_category description: wp_pattern_category routes. paths: /wp/v2/block-directory/search: get: operationId: listBlockDirectorySearch tags: - block-directory summary: List block directory description: Retrieve a collection of block directory from the Starfish Space WordPress REST API. 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 minLength: 1 responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-patterns/categories: get: operationId: listBlockPatternsCategories tags: - block-patterns summary: List block patterns description: Retrieve a collection of block patterns from the Starfish Space WordPress REST API. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-patterns/patterns: get: operationId: listBlockPatternsPatterns tags: - block-patterns summary: List block patterns description: Retrieve a collection of block patterns from the Starfish Space WordPress REST API. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-renderer/{name}: get: operationId: getBlockRendererByName tags: - block-renderer summary: Retrieve a single block renderer description: Retrieve a single block renderer by route parameter from the Starfish Space WordPress REST API. parameters: - name: name in: path required: true description: WordPress route parameter name. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createBlockRendererByName tags: - block-renderer summary: Create or update block renderer description: Create or update a block renderer via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: name in: path required: true description: WordPress route parameter name. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/block-types: get: operationId: listBlockTypes tags: - block-types summary: List block types description: Retrieve a collection of block types from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-types/{namespace}: get: operationId: getBlockTypesByNamespace tags: - block-types summary: Retrieve a single block type description: Retrieve a single block type by route parameter from the Starfish Space WordPress REST API. parameters: - name: namespace in: path required: true description: WordPress route parameter namespace. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/block-types/{namespace}/{name}: get: operationId: getBlockTypesByNamespaceByName tags: - block-types summary: Retrieve a single block type description: Retrieve a single block type by route parameter from the Starfish Space WordPress REST API. parameters: - name: namespace in: path required: true description: WordPress route parameter namespace. schema: type: string - name: name in: path required: true description: WordPress route parameter name. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks: get: operationId: listBlocks tags: - blocks summary: List blocks description: Retrieve a collection of blocks from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: publish type: array items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createBlocks tags: - blocks summary: Create or update blocks description: Create or update a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{id}: get: operationId: getBlocksById tags: - blocks summary: Retrieve a single block description: Retrieve a single block by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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 - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createBlocksById tags: - blocks summary: Create or update block description: Create or update a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateBlocksById tags: - blocks summary: Update block description: Update a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateBlocksById2 tags: - blocks summary: Update block description: Update a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteBlocksById tags: - blocks summary: Delete block description: Delete a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{id}/autosaves: get: operationId: getBlocksByIdAutosaves tags: - blocks summary: Retrieve a single block description: Retrieve a single block by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createBlocksByIdAutosaves tags: - blocks summary: Create or update block description: Create or update a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/blocks/{parent}/autosaves/{id}: get: operationId: getBlocksByParentAutosavesById tags: - blocks summary: Retrieve a single block description: Retrieve a single block by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks/{parent}/revisions: get: operationId: getBlocksByParentRevisions tags: - blocks summary: Retrieve a single block description: Retrieve a single block by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/blocks/{parent}/revisions/{id}: get: operationId: getBlocksByParentRevisionsById tags: - blocks summary: Retrieve a single block description: Retrieve a single block by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deleteBlocksByParentRevisionsById tags: - blocks summary: Delete block description: Delete a block via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/categories: get: operationId: listCategories tags: - categories summary: List categories description: Retrieve a collection of categories from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - name: order in: query required: false description: Order sort attribute ascending or descending. schema: type: string default: asc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string default: name enum: - id - include - name - slug - include_slugs - term_group - description - count - 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: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createCategories tags: - categories summary: Create or update categories description: Create or update a categorie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/categories/{id}: get: operationId: getCategoriesById tags: - categories summary: Retrieve a single categorie description: Retrieve a single categorie by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createCategoriesById tags: - categories summary: Create or update categorie description: Create or update a categorie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateCategoriesById tags: - categories summary: Update categorie description: Update a categorie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateCategoriesById2 tags: - categories summary: Update categorie description: Update a categorie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteCategoriesById tags: - categories summary: Delete categorie description: Delete a categorie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Category' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/comments: get: operationId: listComments tags: - comments summary: List comments description: Retrieve a collection of comments from the Starfish Space WordPress REST API. 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: default: null format: email type: string - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by comment attribute. schema: type: string default: date_gmt enum: - date - date_gmt - id - include - post - parent - type - name: parent in: query required: false description: Limit result set to comments of specific parent IDs. schema: default: [] type: array items: type: integer - name: parent_exclude in: query required: false description: Ensure result set excludes specific parent IDs. schema: default: [] type: array items: type: integer - name: post in: query required: false description: Limit result set to comments assigned to specific post IDs. schema: default: [] type: array items: type: integer - name: status in: query required: false description: Limit result set to comments assigned a specific status. Requires authorization. schema: default: approve type: string - name: type in: query required: false description: Limit result set to comments assigned a specific type. Requires authorization. schema: default: comment type: string - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createComments tags: - comments summary: Create or update comments description: Create or update a comment via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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: default: 0 type: integer description: The ID for the parent of the comment. post: default: 0 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/comments/{id}: get: operationId: getCommentsById tags: - comments summary: Retrieve a single comment description: Retrieve a single comment by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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 - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createCommentsById tags: - comments summary: Create or update comment description: Create or update a comment via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateCommentsById tags: - comments summary: Update comment description: Update a comment via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateCommentsById2 tags: - comments summary: Update comment description: Update a comment via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteCommentsById tags: - comments summary: Delete comment description: Delete a comment via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Comment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-collections: get: operationId: listFontCollections tags: - font-collections summary: List font collections description: Retrieve a collection of font collections from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/font-collections/{slug}: get: operationId: getFontCollectionsBySlug tags: - font-collections summary: Retrieve a single font collection description: Retrieve a single font collection by route parameter from the Starfish Space WordPress REST API. parameters: - name: slug in: path required: true description: WordPress route parameter slug. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/font-families: get: operationId: listFontFamilies tags: - font-families summary: List font families description: Retrieve a collection of font families from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: id enum: - id - include - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createFontFamilies tags: - font-families summary: Create or update font families description: Create or update a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{font_family_id}/font-faces: get: operationId: getFontFamiliesByFont_family_idFontFaces tags: - font-families summary: Retrieve a single font familie description: Retrieve a single font familie by route parameter from the Starfish Space WordPress REST API. parameters: - name: font_family_id in: path required: true description: WordPress route parameter font_family_id. schema: type: string - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: id enum: - id - include responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createFontFamiliesByFont_family_idFontFaces tags: - font-families summary: Create or update font familie description: Create or update a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: font_family_id in: path required: true description: WordPress route parameter font_family_id. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{font_family_id}/font-faces/{id}: get: operationId: getFontFamiliesByFont_family_idFontFacesById tags: - font-families summary: Retrieve a single font familie description: Retrieve a single font familie by route parameter from the Starfish Space WordPress REST API. parameters: - name: font_family_id in: path required: true description: WordPress route parameter font_family_id. schema: type: string - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deleteFontFamiliesByFont_family_idFontFacesById tags: - font-families summary: Delete font familie description: Delete a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: font_family_id in: path required: true description: WordPress route parameter font_family_id. schema: type: string - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/font-families/{id}: get: operationId: getFontFamiliesById tags: - font-families summary: Retrieve a single font familie description: Retrieve a single font familie by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createFontFamiliesById tags: - font-families summary: Create or update font familie description: Create or update a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] put: operationId: updateFontFamiliesById tags: - font-families summary: Update font familie description: Update a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateFontFamiliesById2 tags: - font-families summary: Update font familie description: Update a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteFontFamiliesById tags: - font-families summary: Delete font familie description: Delete a font familie via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/global-styles/themes/{stylesheet}: get: operationId: getGlobalStylesThemesByStylesheet tags: - global-styles summary: Retrieve a single global style description: Retrieve a single global style by route parameter from the Starfish Space WordPress REST API. parameters: - name: stylesheet in: path required: true description: WordPress route parameter stylesheet. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/themes/{stylesheet}/variations: get: operationId: getGlobalStylesThemesByStylesheetVariations tags: - global-styles summary: Retrieve a single global style description: Retrieve a single global style by route parameter from the Starfish Space WordPress REST API. parameters: - name: stylesheet in: path required: true description: WordPress route parameter stylesheet. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/{id}: get: operationId: getGlobalStylesById tags: - global-styles summary: Retrieve a single global style description: Retrieve a single global style by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createGlobalStylesById tags: - global-styles summary: Create or update global style description: Create or update a global style via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateGlobalStylesById tags: - global-styles summary: Update global style description: Update a global style via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateGlobalStylesById2 tags: - global-styles summary: Update global style description: Update a global style via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/global-styles/{parent}/revisions: get: operationId: getGlobalStylesByParentRevisions tags: - global-styles summary: Retrieve a single global style description: Retrieve a single global style by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/global-styles/{parent}/revisions/{id}: get: operationId: getGlobalStylesByParentRevisionsById tags: - global-styles summary: Retrieve a single global style description: Retrieve a single global style by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icons: get: operationId: listIcons tags: - icons summary: List icons description: Retrieve a collection of icons from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/icons/{name}: get: operationId: getIconsByName tags: - icons summary: Retrieve a single icon description: Retrieve a single icon by route parameter from the Starfish Space WordPress REST API. parameters: - name: name in: path required: true description: WordPress route parameter name. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/media: get: operationId: listMedia tags: - media summary: List media description: Retrieve a collection of media from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array items: type: integer default: [] - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array items: type: integer default: [] - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array items: type: integer default: [] - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: inherit type: array 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: default: null type: array items: type: string enum: - image - video - text - application - audio - name: mime_type in: query required: false description: Limit result set to attachments of a particular MIME type or MIME types. schema: default: null type: array items: type: string responses: '200': description: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMedia tags: - media summary: Create or update media description: Create or update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}: get: operationId: getMediaById tags: - media summary: Retrieve a single media description: Retrieve a single media by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMediaById tags: - media summary: Create or update media description: Create or update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateMediaById tags: - media summary: Update media description: Update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateMediaById2 tags: - media summary: Update media description: Update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteMediaById tags: - media summary: Delete media description: Delete a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}/edit: post: operationId: createMediaByIdEdit tags: - media summary: Create or update media description: Create or update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/media/{id}/post-process: post: operationId: createMediaByIdPostProcess tags: - media summary: Create or update media description: Create or update a media via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Attachment' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items: get: operationId: listMenuItems tags: - menu-items summary: List menu items description: Retrieve a collection of menu items from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: asc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: menu_order enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: publish type: array items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMenuItems tags: - menu-items summary: Create or update menu items description: Create or update a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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: default: custom type: string enum: - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". status: default: publish type: string enum: - publish - future - draft - pending - private - acf-disabled description: A named status for the object. parent: default: 0 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: default: 1 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: default: 0 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{id}: get: operationId: getMenuItemsById tags: - menu-items summary: Retrieve a single menu item description: Retrieve a single menu item by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMenuItemsById tags: - menu-items summary: Create or update menu item description: Create or update a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateMenuItemsById tags: - menu-items summary: Update menu item description: Update a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateMenuItemsById2 tags: - menu-items summary: Update menu item description: Update a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteMenuItemsById tags: - menu-items summary: Delete menu item description: Delete a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{id}/autosaves: get: operationId: getMenuItemsByIdAutosaves tags: - menu-items summary: Retrieve a single menu item description: Retrieve a single menu item by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMenuItemsByIdAutosaves tags: - menu-items summary: Create or update menu item description: Create or update a menu item via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/menu-items/{parent}/autosaves/{id}: get: operationId: getMenuItemsByParentAutosavesById tags: - menu-items summary: Retrieve a single menu item description: Retrieve a single menu item by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menu-locations: get: operationId: listMenuLocations tags: - menu-locations summary: List menu locations description: Retrieve a collection of menu locations from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menu-locations/{location}: get: operationId: getMenuLocationsByLocation tags: - menu-locations summary: Retrieve a single menu location description: Retrieve a single menu location by route parameter from the Starfish Space WordPress REST API. parameters: - name: location in: path required: true description: WordPress route parameter location. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/menus: get: operationId: listMenus tags: - menus summary: List menus description: Retrieve a collection of menus from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: asc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string default: name enum: - id - include - name - slug - include_slugs - term_group - description - count - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMenus tags: - menus summary: Create or update menus description: Create or update a menu via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/menus/{id}: get: operationId: getMenusById tags: - menus summary: Retrieve a single menu description: Retrieve a single menu by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createMenusById tags: - menus summary: Create or update menu description: Create or update a menu via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateMenusById tags: - menus summary: Update menu description: Update a menu via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateMenusById2 tags: - menus summary: Update menu description: Update a menu via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteMenusById tags: - menus summary: Delete menu description: Delete a menu via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation: get: operationId: listNavigation tags: - navigation summary: List navigation description: Retrieve a collection of navigation from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: publish type: array items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - any type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createNavigation tags: - navigation summary: Create or update navigation description: Create or update a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{id}: get: operationId: getNavigationById tags: - navigation summary: Retrieve a single navigation description: Retrieve a single navigation by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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 - name: password in: query required: false description: The password for the post if it is password protected. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createNavigationById tags: - navigation summary: Create or update navigation description: Create or update a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateNavigationById tags: - navigation summary: Update navigation description: Update a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateNavigationById2 tags: - navigation summary: Update navigation description: Update a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteNavigationById tags: - navigation summary: Delete navigation description: Delete a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{id}/autosaves: get: operationId: getNavigationByIdAutosaves tags: - navigation summary: Retrieve a single navigation description: Retrieve a single navigation by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createNavigationByIdAutosaves tags: - navigation summary: Create or update navigation description: Create or update a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/navigation/{parent}/autosaves/{id}: get: operationId: getNavigationByParentAutosavesById tags: - navigation summary: Retrieve a single navigation description: Retrieve a single navigation by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/navigation/{parent}/revisions: get: operationId: getNavigationByParentRevisions tags: - navigation summary: Retrieve a single navigation description: Retrieve a single navigation by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/navigation/{parent}/revisions/{id}: get: operationId: getNavigationByParentRevisionsById tags: - navigation summary: Retrieve a single navigation description: Retrieve a single navigation by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deleteNavigationByParentRevisionsById tags: - navigation summary: Delete navigation description: Delete a navigation via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages: get: operationId: listPages tags: - pages summary: List pages description: Retrieve a collection of pages from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array items: type: integer default: [] - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order - name: parent in: query required: false description: Limit result set to items with particular parent IDs. schema: type: array items: type: integer default: [] - name: parent_exclude in: query required: false description: Limit result set to all items except those of a particular parent ID. schema: type: array items: type: integer default: [] - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: publish type: array items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - any type: string responses: '200': description: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPages tags: - pages summary: Create or update pages description: Create or update a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{id}: get: operationId: getPagesById tags: - pages summary: Retrieve a single page description: Retrieve a single page by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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 - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPagesById tags: - pages summary: Create or update page description: Create or update a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updatePagesById tags: - pages summary: Update page description: Update a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updatePagesById2 tags: - pages summary: Update page description: Update a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deletePagesById tags: - pages summary: Delete page description: Delete a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{id}/autosaves: get: operationId: getPagesByIdAutosaves tags: - pages summary: Retrieve a single page description: Retrieve a single page by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPagesByIdAutosaves tags: - pages summary: Create or update page description: Create or update a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/pages/{parent}/autosaves/{id}: get: operationId: getPagesByParentAutosavesById tags: - pages summary: Retrieve a single page description: Retrieve a single page by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/pages/{parent}/revisions: get: operationId: getPagesByParentRevisions tags: - pages summary: Retrieve a single page description: Retrieve a single page by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/pages/{parent}/revisions/{id}: get: operationId: getPagesByParentRevisionsById tags: - pages summary: Retrieve a single page description: Retrieve a single page by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deletePagesByParentRevisionsById tags: - pages summary: Delete page description: Delete a page via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Page' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/pattern-directory/patterns: get: operationId: listPatternDirectoryPatterns tags: - pattern-directory summary: List pattern directory description: Retrieve a collection of pattern directory from the Starfish Space WordPress REST API. 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 minLength: 1 - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - favorite_count responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/plugins: get: operationId: listPlugins tags: - plugins summary: List plugins description: Retrieve a collection of plugins from the Starfish Space WordPress REST API. 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 responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPlugins tags: - plugins summary: Create or update plugins description: Create or update a plugin via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true content: application/json: schema: type: object properties: slug: type: string pattern: '[\w\-]+' description: WordPress.org plugin directory slug. status: type: string enum: - inactive - active default: inactive description: The plugin activation status. required: - slug security: - basicAuth: [] - cookieNonce: [] /wp/v2/plugins/{plugin}: get: operationId: getPluginsByPlugin tags: - plugins summary: Retrieve a single plugin description: Retrieve a single plugin by route parameter from the Starfish Space WordPress REST API. parameters: - name: plugin in: path required: true description: WordPress route parameter plugin. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPluginsByPlugin tags: - plugins summary: Create or update plugin description: Create or update a plugin via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: plugin in: path required: true description: WordPress route parameter plugin. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: The plugin activation status. security: - basicAuth: [] - cookieNonce: [] put: operationId: updatePluginsByPlugin tags: - plugins summary: Update plugin description: Update a plugin via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: plugin in: path required: true description: WordPress route parameter plugin. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: The plugin activation status. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updatePluginsByPlugin2 tags: - plugins summary: Update plugin description: Update a plugin via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: plugin in: path required: true description: WordPress route parameter plugin. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: The plugin activation status. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deletePluginsByPlugin tags: - plugins summary: Delete plugin description: Delete a plugin via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: plugin in: path required: true description: WordPress route parameter plugin. schema: type: string - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts: get: operationId: listPosts tags: - posts summary: List posts description: Retrieve a collection of posts from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: author_exclude in: query required: false description: Ensure result set excludes posts assigned to specific authors. schema: type: array items: type: integer default: [] - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by post attribute. schema: type: string default: date enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array 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: default: publish type: array items: enum: - publish - future - draft - pending - private - trash - auto-draft - inherit - request-pending - request-confirmed - request-failed - request-completed - acf-disabled - 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 uniqueItems: true items: enum: - standard - aside - chat - gallery - link - image - quote - status - video - audio type: string responses: '200': description: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPosts tags: - posts summary: Create or update posts description: Create or update a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{id}: get: operationId: getPostsById tags: - posts summary: Retrieve a single post description: Retrieve a single post by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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 - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPostsById tags: - posts summary: Create or update post description: Create or update a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updatePostsById tags: - posts summary: Update post description: Update a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updatePostsById2 tags: - posts summary: Update post description: Update a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deletePostsById tags: - posts summary: Delete post description: Delete a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{id}/autosaves: get: operationId: getPostsByIdAutosaves tags: - posts summary: Retrieve a single post description: Retrieve a single post by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createPostsByIdAutosaves tags: - posts summary: Create or update post description: Create or update a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/posts/{parent}/autosaves/{id}: get: operationId: getPostsByParentAutosavesById tags: - posts summary: Retrieve a single post description: Retrieve a single post by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/posts/{parent}/revisions: get: operationId: getPostsByParentRevisions tags: - posts summary: Retrieve a single post description: Retrieve a single post by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/posts/{parent}/revisions/{id}: get: operationId: getPostsByParentRevisionsById tags: - posts summary: Retrieve a single post description: Retrieve a single post by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deletePostsByParentRevisionsById tags: - posts summary: Delete post description: Delete a post via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Post' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/search: get: operationId: listSearch tags: - search summary: List search description: Retrieve a collection of search from the Starfish Space WordPress REST API. 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: default: post type: string enum: - post - term - post-format - name: subtype in: query required: false description: Limit results to items of one or more object subtypes. schema: default: any type: array items: enum: - post - page - category - post_tag - any type: string - name: exclude in: query required: false description: Ensure result set excludes specific IDs. schema: type: array items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] responses: '200': description: Successful response. content: application/json: schema: type: array items: $ref: '#/components/schemas/SearchResult' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/settings: get: operationId: listSettings tags: - settings summary: List settings description: Retrieve a collection of settings from the Starfish Space WordPress REST API. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createSettings tags: - settings summary: Create or update settings description: Create or update a setting via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: Site title. description: type: string description: Site tagline. url: type: string format: uri description: Site URL. email: type: string format: email description: This address is used for admin purposes, like new user notification. timezone: type: string description: A city in the same timezone as you. date_format: type: string description: A date format for all date strings. time_format: type: string description: A time format for all time strings. start_of_week: type: integer description: A day number of the week that the week should start on. language: type: string description: WordPress locale code. use_smilies: type: boolean description: Convert emoticons like :-) and :-P to graphics on display. default_category: type: integer description: Default post category. default_post_format: type: string description: Default post format. posts_per_page: type: integer description: Blog pages show at most. show_on_front: type: string description: What to show on the front page page_on_front: type: integer description: The ID of the page that should be displayed on the front page page_for_posts: type: integer description: The ID of the page that should display the latest posts default_ping_status: type: string enum: - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: - open - closed description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateSettings tags: - settings summary: Update settings description: Update a setting via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: Site title. description: type: string description: Site tagline. url: type: string format: uri description: Site URL. email: type: string format: email description: This address is used for admin purposes, like new user notification. timezone: type: string description: A city in the same timezone as you. date_format: type: string description: A date format for all date strings. time_format: type: string description: A time format for all time strings. start_of_week: type: integer description: A day number of the week that the week should start on. language: type: string description: WordPress locale code. use_smilies: type: boolean description: Convert emoticons like :-) and :-P to graphics on display. default_category: type: integer description: Default post category. default_post_format: type: string description: Default post format. posts_per_page: type: integer description: Blog pages show at most. show_on_front: type: string description: What to show on the front page page_on_front: type: integer description: The ID of the page that should be displayed on the front page page_for_posts: type: integer description: The ID of the page that should display the latest posts default_ping_status: type: string enum: - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: - open - closed description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateSettings2 tags: - settings summary: Update settings description: Update a setting via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: Site title. description: type: string description: Site tagline. url: type: string format: uri description: Site URL. email: type: string format: email description: This address is used for admin purposes, like new user notification. timezone: type: string description: A city in the same timezone as you. date_format: type: string description: A date format for all date strings. time_format: type: string description: A time format for all time strings. start_of_week: type: integer description: A day number of the week that the week should start on. language: type: string description: WordPress locale code. use_smilies: type: boolean description: Convert emoticons like :-) and :-P to graphics on display. default_category: type: integer description: Default post category. default_post_format: type: string description: Default post format. posts_per_page: type: integer description: Blog pages show at most. show_on_front: type: string description: What to show on the front page page_on_front: type: integer description: The ID of the page that should be displayed on the front page page_for_posts: type: integer description: The ID of the page that should display the latest posts default_ping_status: type: string enum: - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: - open - closed description: Allow people to submit comments on new posts. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. security: - basicAuth: [] - cookieNonce: [] /wp/v2/sidebars: get: operationId: listSidebars tags: - sidebars summary: List sidebars description: Retrieve a collection of sidebars from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/sidebars/{id}: get: operationId: getSidebarsById tags: - sidebars summary: Retrieve a single sidebar description: Retrieve a single sidebar by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createSidebarsById tags: - sidebars summary: Create or update sidebar description: Create or update a sidebar via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateSidebarsById tags: - sidebars summary: Update sidebar description: Update a sidebar via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateSidebarsById2 tags: - sidebars summary: Update sidebar description: Update a sidebar via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: widgets: type: array items: type: - object - string description: Nested widgets. security: - basicAuth: [] - cookieNonce: [] /wp/v2/statuses: get: operationId: listStatuses tags: - statuses summary: List statuses description: Retrieve a collection of statuses from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Status' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/statuses/{status}: get: operationId: getStatusesByStatus tags: - statuses summary: Retrieve a single statuse description: Retrieve a single statuse by route parameter from the Starfish Space WordPress REST API. parameters: - name: status in: path required: true description: WordPress route parameter status. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Status' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/tags: get: operationId: listTags tags: - tags summary: List tags description: Retrieve a collection of tags from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: asc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string default: name enum: - id - include - name - slug - include_slugs - term_group - description - count - 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: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTags tags: - tags summary: Create or update tags description: Create or update a tag via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/tags/{id}: get: operationId: getTagsById tags: - tags summary: Retrieve a single tag description: Retrieve a single tag by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTagsById tags: - tags summary: Create or update tag description: Create or update a tag via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateTagsById tags: - tags summary: Update tag description: Update a tag via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateTagsById2 tags: - tags summary: Update tag description: Update a tag via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteTagsById tags: - tags summary: Delete tag description: Delete a tag via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Tag' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/taxonomies: get: operationId: listTaxonomies tags: - taxonomies summary: List taxonomies description: Retrieve a collection of taxonomies from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Taxonomy' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/taxonomies/{taxonomy}: get: operationId: getTaxonomiesByTaxonomy tags: - taxonomies summary: Retrieve a single taxonomie description: Retrieve a single taxonomie by route parameter from the Starfish Space WordPress REST API. parameters: - name: taxonomy in: path required: true description: WordPress route parameter taxonomy. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Taxonomy' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts: get: operationId: listTemplateParts tags: - template-parts summary: List template parts description: Retrieve a collection of template parts from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplateParts tags: - template-parts summary: Create or update template parts description: Create or update a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true content: application/json: schema: type: object properties: slug: type: string minLength: 1 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: default: '' 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: default: '' 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: default: '' type: string description: Description of template. status: default: publish type: string enum: - publish - future - draft - pending - private - acf-disabled 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/lookup: get: operationId: listTemplatePartsLookup tags: - template-parts summary: List template parts description: Retrieve a collection of template parts from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts/{id}: get: operationId: getTemplatePartsById tags: - template-parts summary: Retrieve a single template part description: Retrieve a single template part by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplatePartsById tags: - template-parts summary: Create or update template part description: Create or update a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled 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.) security: - basicAuth: [] - cookieNonce: [] put: operationId: updateTemplatePartsById tags: - template-parts summary: Update template part description: Update a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled 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.) security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateTemplatePartsById2 tags: - template-parts summary: Update template part description: Update a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled 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.) security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteTemplatePartsById tags: - template-parts summary: Delete template part description: Delete a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/{id}/autosaves: get: operationId: getTemplatePartsByIdAutosaves tags: - template-parts summary: Retrieve a single template part description: Retrieve a single template part by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplatePartsByIdAutosaves tags: - template-parts summary: Create or update template part description: Create or update a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled 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.) security: - basicAuth: [] - cookieNonce: [] /wp/v2/template-parts/{parent}/autosaves/{id}: get: operationId: getTemplatePartsByParentAutosavesById tags: - template-parts summary: Retrieve a single template part description: Retrieve a single template part by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts/{parent}/revisions: get: operationId: getTemplatePartsByParentRevisions tags: - template-parts summary: Retrieve a single template part description: Retrieve a single template part by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/template-parts/{parent}/revisions/{id}: get: operationId: getTemplatePartsByParentRevisionsById tags: - template-parts summary: Retrieve a single template part description: Retrieve a single template part by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deleteTemplatePartsByParentRevisionsById tags: - template-parts summary: Delete template part description: Delete a template part via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates: get: operationId: listTemplates tags: - templates summary: List templates description: Retrieve a collection of templates from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplates tags: - templates summary: Create or update templates description: Create or update a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true content: application/json: schema: type: object properties: slug: type: string minLength: 1 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: default: '' 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: default: '' 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: default: '' type: string description: Description of template. status: default: publish type: string enum: - publish - future - draft - pending - private - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. required: - slug security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/lookup: get: operationId: listTemplatesLookup tags: - templates summary: List templates description: Retrieve a collection of templates from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates/{id}: get: operationId: getTemplatesById tags: - templates summary: Retrieve a single template description: Retrieve a single template by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplatesById tags: - templates summary: Create or update template description: Create or update a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateTemplatesById tags: - templates summary: Update template description: Update a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateTemplatesById2 tags: - templates summary: Update template description: Update a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteTemplatesById tags: - templates summary: Delete template description: Delete a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - name: force in: query required: false description: Whether to bypass Trash and force deletion. schema: type: boolean default: false responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/{id}/autosaves: get: operationId: getTemplatesByIdAutosaves tags: - templates summary: Retrieve a single template description: Retrieve a single template by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createTemplatesByIdAutosaves tags: - templates summary: Create or update template description: Create or update a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: slug: type: string minLength: 1 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 - acf-disabled description: Status of template. author: type: integer description: The ID for the author of the template. security: - basicAuth: [] - cookieNonce: [] /wp/v2/templates/{parent}/autosaves/{id}: get: operationId: getTemplatesByParentAutosavesById tags: - templates summary: Retrieve a single template description: Retrieve a single template by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates/{parent}/revisions: get: operationId: getTemplatesByParentRevisions tags: - templates summary: Retrieve a single template description: Retrieve a single template by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. 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 - 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: desc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by object attribute. schema: type: string default: date enum: - date - id - include - relevance - slug - include_slugs - title responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/templates/{parent}/revisions/{id}: get: operationId: getTemplatesByParentRevisionsById tags: - templates summary: Retrieve a single template description: Retrieve a single template by route parameter from the Starfish Space WordPress REST API. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' delete: operationId: deleteTemplatesByParentRevisionsById tags: - templates summary: Delete template description: Delete a template via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: parent in: path required: true description: WordPress route parameter parent. schema: type: integer - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/themes: get: operationId: listThemes tags: - themes summary: List themes description: Retrieve a collection of themes from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/themes/{stylesheet}: get: operationId: getThemesByStylesheet tags: - themes summary: Retrieve a single theme description: Retrieve a single theme by route parameter from the Starfish Space WordPress REST API. parameters: - name: stylesheet in: path required: true description: WordPress route parameter stylesheet. schema: type: string responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/types: get: operationId: listTypes tags: - types summary: List types description: Retrieve a collection of types from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: array items: $ref: '#/components/schemas/Type' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/types/{type}: get: operationId: getTypesByType tags: - types summary: Retrieve a single type description: Retrieve a single type by route parameter from the Starfish Space WordPress REST API. parameters: - name: type in: path required: true description: WordPress route parameter type. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/Type' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/users: get: operationId: listUsers tags: - users summary: List users description: Retrieve a collection of users from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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: default: asc enum: - asc - desc type: string - name: orderby in: query required: false description: Sort collection by user attribute. schema: default: name enum: - id - include - name - registered_date - slug - include_slugs - email - url type: string - 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 - name: search_columns in: query required: false description: Array of column names to be searched. schema: default: [] type: array items: enum: - email - name - id - username - slug type: string responses: '200': description: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createUsers tags: - users summary: Create or update users description: Create or update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 description: Meta fields. required: - username - email - password security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/me: get: operationId: listUsersMe tags: - users summary: List users description: Retrieve a collection of users from the Starfish Space WordPress REST API. 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: Successful response. 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. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createUsersMe tags: - users summary: Create or update users description: Create or update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateUsersMe tags: - users summary: Update users description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateUsersMe2 tags: - users summary: Update users description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteUsersMe tags: - users summary: Delete users description: Delete a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{id}: get: operationId: getUsersById tags: - users summary: Retrieve a single user description: Retrieve a single user by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createUsersById tags: - users summary: Create or update user description: Create or update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateUsersById tags: - users summary: Update user description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateUsersById2 tags: - users summary: Update user description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 description: Meta fields. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteUsersById tags: - users summary: Delete user description: Delete a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{user_id}/application-passwords: get: operationId: getUsersByUser_idApplicationPasswords tags: - users summary: Retrieve a single user description: Retrieve a single user by route parameter from the Starfish Space WordPress REST API. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createUsersByUser_idApplicationPasswords tags: - users summary: Create or update user description: Create or update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 minLength: 1 pattern: .*\S.* description: The name of the application password. required: - name security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteUsersByUser_idApplicationPasswords tags: - users summary: Delete user description: Delete a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/users/{user_id}/application-passwords/introspect: get: operationId: getUsersByUser_idApplicationPasswordsIntrospect tags: - users summary: Retrieve a single user description: Retrieve a single user by route parameter from the Starfish Space WordPress REST API. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/users/{user_id}/application-passwords/{uuid}: get: operationId: getUsersByUser_idApplicationPasswordsByUuid tags: - users summary: Retrieve a single user description: Retrieve a single user by route parameter from the Starfish Space WordPress REST API. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - name: uuid in: path required: true description: WordPress route parameter uuid. schema: type: string - 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: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createUsersByUser_idApplicationPasswordsByUuid tags: - users summary: Create or update user description: Create or update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - name: uuid in: path required: true description: WordPress route parameter uuid. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 minLength: 1 pattern: .*\S.* description: The name of the application password. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateUsersByUser_idApplicationPasswordsByUuid tags: - users summary: Update user description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - name: uuid in: path required: true description: WordPress route parameter uuid. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 minLength: 1 pattern: .*\S.* description: The name of the application password. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateUsersByUser_idApplicationPasswordsByUuid2 tags: - users summary: Update user description: Update a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - name: uuid in: path required: true description: WordPress route parameter uuid. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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 minLength: 1 pattern: .*\S.* description: The name of the application password. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteUsersByUser_idApplicationPasswordsByUuid tags: - users summary: Delete user description: Delete a user via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: user_id in: path required: true description: WordPress route parameter user_id. schema: type: string - name: uuid in: path required: true description: WordPress route parameter uuid. schema: type: string responses: '200': description: Successful response. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/widget-types: get: operationId: listWidgetTypes tags: - widget-types summary: List widget types description: Retrieve a collection of widget types from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/widget-types/{id}: get: operationId: getWidgetTypesById tags: - widget-types summary: Retrieve a single widget type description: Retrieve a single widget type by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' /wp/v2/widget-types/{id}/encode: post: operationId: createWidgetTypesByIdEncode tags: - widget-types summary: Create or update widget type description: Create or update a widget type via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] /wp/v2/widget-types/{id}/render: post: operationId: createWidgetTypesByIdRender tags: - widget-types summary: Create or update widget type description: Create or update a widget type via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: false content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. security: - basicAuth: [] - cookieNonce: [] /wp/v2/widgets: get: operationId: listWidgets tags: - widgets summary: List widgets description: Retrieve a collection of widgets from the Starfish Space WordPress REST API. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createWidgets tags: - widgets summary: Create or update widgets description: Create or update a widget via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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: default: wp_inactive_widgets 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. required: - sidebar security: - basicAuth: [] - cookieNonce: [] /wp/v2/widgets/{id}: get: operationId: getWidgetsById tags: - widgets summary: Retrieve a single widget description: Retrieve a single widget by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createWidgetsById tags: - widgets summary: Create or update widget description: Create or update a widget via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateWidgetsById tags: - widgets summary: Update widget description: Update a widget via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateWidgetsById2 tags: - widgets summary: Update widget description: Update a widget via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWidgetsById tags: - widgets summary: Delete widget description: Delete a widget via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] /wp/v2/wp_pattern_category: get: operationId: listWpPatternCategory tags: - wp_pattern_category summary: List wp_pattern_category description: Retrieve a collection of wp_pattern_category from the Starfish Space WordPress REST API. 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 items: type: integer default: [] - name: include in: query required: false description: Limit result set to specific IDs. schema: type: array items: type: integer default: [] - 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 default: asc enum: - asc - desc - name: orderby in: query required: false description: Sort collection by term attribute. schema: type: string default: name enum: - id - include - name - slug - include_slugs - term_group - description - count - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createWpPatternCategory tags: - wp_pattern_category summary: Create or update wp_pattern_category description: Create or update a wp_pattern_category via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: [] responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' requestBody: required: true 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 security: - basicAuth: [] - cookieNonce: [] /wp/v2/wp_pattern_category/{id}: get: operationId: getWpPatternCategoryById tags: - wp_pattern_category summary: Retrieve a single wp_pattern_category description: Retrieve a single wp_pattern_category by route parameter from the Starfish Space WordPress REST API. parameters: - name: id in: path required: true description: WordPress route parameter id. 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' post: operationId: createWpPatternCategoryById tags: - wp_pattern_category summary: Create or update wp_pattern_category description: Create or update a wp_pattern_category via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] put: operationId: updateWpPatternCategoryById tags: - wp_pattern_category summary: Update wp_pattern_category description: Update a wp_pattern_category via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] patch: operationId: updateWpPatternCategoryById2 tags: - wp_pattern_category summary: Update wp_pattern_category description: Update a wp_pattern_category via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer responses: '200': description: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' 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. security: - basicAuth: [] - cookieNonce: [] delete: operationId: deleteWpPatternCategoryById tags: - wp_pattern_category summary: Delete wp_pattern_category description: Delete a wp_pattern_category via the Starfish Space WordPress REST API. Requires an authenticated WordPress user with sufficient capabilities. parameters: - name: id in: path required: true description: WordPress route parameter id. schema: type: integer - 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: Successful response. content: application/json: schema: type: object '400': description: Invalid parameter. content: application/json: schema: $ref: '#/components/schemas/RestError' '401': description: Authentication required. content: application/json: schema: $ref: '#/components/schemas/RestError' '403': description: Not allowed for the current user. content: application/json: schema: $ref: '#/components/schemas/RestError' '404': description: No route or resource matched the request. content: application/json: schema: $ref: '#/components/schemas/RestError' security: - basicAuth: [] - cookieNonce: [] components: securitySchemes: basicAuth: type: http scheme: basic description: WordPress application password (username + application password). cookieNonce: type: apiKey in: header name: X-WP-Nonce description: WordPress cookie authentication nonce, for same-origin requests. 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 - acf-disabled 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: footnotes: type: string title: '' description: '' default: '' 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 acf: description: ACF field data type: object properties: [] links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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 - acf-disabled 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 acf: description: ACF field data type: object properties: [] links: - rel: https://api.w.org/action-publish title: The current user can publish this post. href: https://www.starfishspace.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://www.starfishspace.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://www.starfishspace.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 - acf-disabled 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 acf: description: ACF field data type: object properties: [] 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 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 links: - rel: https://api.w.org/action-unfiltered-html title: The current user can post unfiltered HTML markup and JavaScript. href: https://www.starfishspace.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://www.starfishspace.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: [] acf: description: ACF field data type: object 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 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 acf: description: ACF field data type: object properties: [] 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 meta: description: Meta fields. type: object context: - view - edit properties: _wp_note_status: type: string title: '' description: Note resolution status default: '' enum: - resolved - reopen acf: description: ACF field data type: object properties: [] SearchResult: $schema: http://json-schema.org/draft-04/schema# title: search-result type: object properties: id: description: Unique identifier for the object. type: - integer - string context: - view - embed readonly: true title: description: The title for the object. type: string context: - view - embed readonly: true url: description: URL to the object. type: string format: uri context: - view - embed readonly: true type: description: Object type. type: string enum: - post - term - post-format context: - view - embed readonly: true subtype: description: Object subtype. type: string enum: - post - page - category - post_tag context: - view - embed readonly: true Type: $schema: http://json-schema.org/draft-04/schema# title: type type: object properties: capabilities: description: All capabilities used by the post type. type: object context: - edit readonly: true description: description: A human-readable description of the post type. type: string context: - view - edit readonly: true hierarchical: description: Whether or not the post type should have children. type: boolean context: - view - edit readonly: true viewable: description: Whether or not the post type can be viewed. type: boolean context: - edit readonly: true labels: description: Human-readable labels for the post type for various contexts. type: object context: - edit readonly: true name: description: The title for the post type. type: string context: - view - edit - embed readonly: true slug: description: An alphanumeric identifier for the post type. type: string context: - view - edit - embed readonly: true supports: description: All features, supported by the post type. type: object context: - edit readonly: true has_archive: description: If the value is a string, the value will be used as the archive slug. If the value is false the post type has no archive. type: - string - boolean context: - view - edit readonly: true taxonomies: description: Taxonomies associated with post type. type: array items: type: string context: - view - edit readonly: true rest_base: description: REST base route for the post type. type: string context: - view - edit - embed readonly: true rest_namespace: description: REST route's namespace for the post type. type: string context: - view - edit - embed readonly: true visibility: description: The visibility settings for the post type. type: object context: - edit readonly: true properties: show_ui: description: Whether to generate a default UI for managing this post type. type: boolean show_in_nav_menus: description: Whether to make the post type available for selection in navigation menus. type: boolean icon: description: The icon for the post type. type: - string - 'null' context: - view - edit - embed readonly: true template: type: - array description: The block template associated with the post type. readonly: true context: - view - edit - embed template_lock: type: - string - boolean enum: - all - insert - contentOnly - false description: The template_lock associated with the post type, or false if none. readonly: true context: - view - edit - embed Status: $schema: http://json-schema.org/draft-04/schema# title: status type: object properties: name: description: The title for the status. type: string context: - embed - view - edit readonly: true private: description: Whether posts with this status should be private. type: boolean context: - edit readonly: true protected: description: Whether posts with this status should be protected. type: boolean context: - edit readonly: true public: description: Whether posts of this status should be shown in the front end of the site. type: boolean context: - view - edit readonly: true queryable: description: Whether posts with this status should be publicly-queryable. type: boolean context: - view - edit readonly: true show_in_list: description: Whether to include posts in the edit listing for their post type. type: boolean context: - edit readonly: true slug: description: An alphanumeric identifier for the status. type: string context: - embed - view - edit readonly: true date_floating: description: Whether posts of this status may have floating published dates. type: boolean context: - view - edit readonly: true Taxonomy: $schema: http://json-schema.org/draft-04/schema# title: taxonomy type: object properties: capabilities: description: All capabilities used by the taxonomy. type: object context: - edit readonly: true description: description: A human-readable description of the taxonomy. type: string context: - view - edit readonly: true hierarchical: description: Whether or not the taxonomy should have children. type: boolean context: - view - edit readonly: true labels: description: Human-readable labels for the taxonomy for various contexts. type: object context: - edit readonly: true name: description: The title for the taxonomy. type: string context: - view - edit - embed readonly: true slug: description: An alphanumeric identifier for the taxonomy. type: string context: - view - edit - embed readonly: true show_cloud: description: Whether or not the term cloud should be displayed. type: boolean context: - edit readonly: true types: description: Types associated with the taxonomy. type: array items: type: string context: - view - edit readonly: true rest_base: description: REST base route for the taxonomy. type: string context: - view - edit - embed readonly: true rest_namespace: description: REST namespace route for the taxonomy. type: string context: - view - edit - embed readonly: true visibility: description: The visibility settings for the taxonomy. type: object context: - edit readonly: true properties: public: description: Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users. type: boolean publicly_queryable: description: Whether the taxonomy is publicly queryable. type: boolean show_ui: description: Whether to generate a default UI for managing this taxonomy. type: boolean show_admin_column: description: Whether to allow automatic creation of taxonomy columns on associated post-types table. type: boolean show_in_nav_menus: description: Whether to make the taxonomy available for selection in navigation menus. type: boolean show_in_quick_edit: description: Whether to show the taxonomy in the quick/bulk edit panel. type: boolean RestError: title: rest-error type: object description: WordPress REST API error envelope, as returned by this API. properties: code: type: string description: Machine-readable error code. message: type: string description: Human-readable error message. data: type: object properties: status: type: integer description: HTTP status code.