Skip to content
Speccy

Ask for a review and assign reviewers (REQ-090). A draft moves to in review.

POST
/docs/{docId}/review-request
curl --request POST \
  --url https://example.com/api/v1/docs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review-request \
  --header 'Content-Type: application/json' \
  --data '{ "reviewers": [ "example" ] }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
docId
required
string format: uuid

The ID of one spec doc.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reviewers
required

User IDs.

Array<string>
Examplegenerated
{
  "reviewers": [
    "example"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200”

The status.

Media typeapplication/json
object
status
required
string
Allowed values: draft in_review approved superseded
reviewers
required
Array<string>
approvals
required
Array<object>
object
by
required
string
version_id
required
string format: uuid
at
required
string format: date-time
required
required
integer
can_request
required
boolean
can_approve
required
boolean
approve_blocked_by

Why the caller cannot approve now, when they cannot.

string
Example
{
  "status": "draft"
}

default

Section titled “default”

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object
type
required
string
title
required
string
status
required
integer
detail
string
instance
string
code
required

A stable machine-readable error code.

string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}