Create Term Revision

POST /terms/{term_ref}/revisions

Creates a canonical revision proposal for the identified term and records its accepting decision.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/terms/{term_ref}/revisions" \
  -X POST \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "description": ""
}'

Request

Request Path

term_ref

Public term reference.

stringrequired

Request Body

{
  "description": "",
  "name": "",
  "remarks": ""
}

description

stringrequired

name

stringnulloptional

remarks

stringnulloptional

Responses

201 Created

Revision created.

{
  "data": {
    "decision": {
      "actor": {},
      "created_at": "2026-01-01T00:00:00Z",
      "ref": "00000000-0000-4000-8000-000000000000",
      "remarks": "",
      "revision": {},
      "status": "accepted"
    },
    "revision": {
      "actor": {},
      "created_at": "2026-01-01T00:00:00Z",
      "decisions": [
        {
          "actor": {},
          "created_at": "2026-01-01T00:00:00Z",
          "ref": "00000000-0000-4000-8000-000000000000",
          "remarks": "",
          "revision": {},
          "status": "accepted"
        }
      ],
      "description": "",
      "latest": true,
      "name": "",
      "number": 1,
      "ref": "00000000-0000-4000-8000-000000000000"
    }
  }
}

data

objectrequired

data.decision

Canonical decision resource.

objectrequired

data.decision.actor

objectrequired

data.decision.created_at

string (date-time)required

data.decision.ref

Public stable resource reference.

string (uuid)required

data.decision.remarks

stringnullrequired

data.decision.revision

objectrequired

data.decision.status

accepted | rejectedrequired

data.revision

Canonical revision resource.

objectrequired

data.revision.actor

objectrequired

data.revision.created_at

string (date-time)required

data.revision.decisions

object[]required

data.revision.description

stringnullrequired

data.revision.latest

booleanrequired

data.revision.name

stringnullrequired

data.revision.number

integerrequired

data.revision.ref

Public stable resource reference.

string (uuid)required

400 Bad Request

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

404 Not Found

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

409 Conflict

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional

422 Unprocessable Entity

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional