Skip to content
Artbucket

Name a version

PATCH
/api/v1/brands/{slug}/versions/{number}
curl --request PATCH \
  --url http://localhost:3000/api/v1/brands/example/versions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

A named version is a checkpoint: later edits start a new version instead of extending it.

Scope: write.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
slug
required
string

Brand slug

number
required
string

Version number

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
Any of:
string
>= 1 characters <= 120 characters
Examplegenerated
{
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The version

Media typeapplication/json
object
data
required
object
number
required
integer
>= -9007199254740991 <= 9007199254740991
kind
required
string
Allowed values: baseline edit restore
name
required
string | null
actor
required

Who: a person’s name, an API key’s name, or “web” for the app without an account

string
changed
required

Keys touched; a page as page:{slug}, and theme

Array<string>
restoredFrom
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
summary
required
string
rules
required
integer
>= -9007199254740991 <= 9007199254740991
pages
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
publishedAt
required
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
publishedBy
required
string | null
note
required

What changed, for readers, given when it was published

string | null
noteImage
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
createdAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
updatedAt
required

Edits close together extend a version; this is its last

string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
Example
{
  "data": {
    "kind": "baseline"
  }
}

default

Section titled “default”

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}