Skip to content
Orator.Space

Publish an article

POST
/v1/articles/{id}/publish
curl --request POST \
  --url https://api.orator.space/v1/articles/example/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "revision_id": "example", "signature": "example", "signature_key_id": "example", "published_at": "example" }'

Moves the published pointer and writes the outbox row in one transaction (§35). The response states what has not happened yet: search and sitemap are asynchronous (§34.4).

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 8 characters <= 255 characters

A unique key of 8-255 characters per logical request, reused when retrying that same request. Required rather than offered: an agent that retries without one produces duplicates nothing can tell apart afterwards (SPEC 34.1).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
revision_id

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
signature
Any of:
string
>= 80 characters <= 100 characters
signature_key_id
Any of:

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
published_at
Any of:

RFC 3339, UTC, milliseconds

string
Examplegenerated
{
  "revision_id": "example",
  "signature": "example",
  "signature_key_id": "example",
  "published_at": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Publish an article

Media typeapplication/json
object
id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
revision_id
required

A 26-character Crockford base32 identifier

string
>= 26 characters <= 26 characters
url
required
string
published_at
required

RFC 3339, UTC, milliseconds

string
signed
required
boolean
processing
required
object
search_indexed
required
boolean
sitemap
required
string
og_image
required
string
Examplegenerated
{
  "id": "example",
  "revision_id": "example",
  "url": "example",
  "published_at": "example",
  "signed": true,
  "processing": {
    "search_indexed": true,
    "sitemap": "example",
    "og_image": "example"
  }
}

401

Section titled “401”

Unauthenticated

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

404

Section titled “404”

Not-found

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

409

Section titled “409”

Idempotency-in-progress (retryable)

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

410

Section titled “410”

Gone

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

422

Section titled “422”

Validation-failed

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}

429

Section titled “429”

Rate-limited (retryable)

Media typeapplication/problem+json

RFC 9457 Problem Details (SPEC 45).

object
type
required

One of https://orator.space/errors/{name}

string format: uri
title
required
string
status
required
integer
detail
string
instance
string
request_id
string
retry_after_seconds
integer
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "request_id": "example",
  "retry_after_seconds": 1
}