OpenAPI Specification
openapi: 3.2.0
info:
title: Starfish Space Website Content API (WordPress REST v2) Blocks API
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: blocks
description: Reusable editor blocks.
paths:
/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
# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/starfish-space/refs/heads/main/openapi/starfish-space-blocks-api-openapi.yml