Skip to content
Developers

Replace a bundle

PUT/v2/themes/{themeId}/code-graphics/{graphicId}/bundle

PUT
/v2/themes/{themeId}/code-graphics/{graphicId}/bundle
curl --request PUT \
  --url https://api.ligr.live/rest/v2/themes/1/code-graphics/example/bundle \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "uploadSessionId": "823d14c6-ef4e-4d72-932e-20d8ed422e3c", "files": [ { "name": "index.html", "mime": "text/html", "size": 1240, "hash": "sha256:6f1c" }, { "name": "assets/app.js", "mime": "application/javascript", "size": 8300, "hash": "sha256:9b02" } ] }'

Beta. This operation can change between minor versions. See Beta status.

Records the complete file set of the code graphic. The request deletes each file you leave out, and stateMachine applies a new manifest at the same time.

Upload every changed file first, then send the uploadSessionId that POST .../uploads returned. The request moves each named file of that session into the graphic, and clears the session afterwards. It reads no other session, so a file another session left behind is never promoted. A file you name but do not upload in this session is kept only when the graphic already holds it from an earlier bundle. Otherwise the request fails with CODE_GRAPHIC_INVALID and names the file.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
themeId
required

Entity identifier

integer format: int32
>= 1

The theme identifier

graphicId
required
string

The graphic identifier

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Leave out stateMachine to keep the stored one.

object
files
required

The complete file set of the bundle. A file left out is deleted.

Array<object>
<= 2000 items
object
name
required

Path of the file inside the bundle.

string
mime
required

Content type of the file.

string
size
required

Size of the file in bytes.

integer format: int32
hash
required

Content hash of the file.

string
stateMachine

Runtime, control variables and user expressions of a code graphic.

The index signature keeps the keys. tsoa strips every key of a Record<string, unknown>, because that type declares no properties.

object
key
additional properties
uploadSessionId

The session the files were uploaded in, from the POST .../uploads answer. The request moves the files of this session into the graphic, and clears the session afterwards. Leave it out only when every named file is already in the graphic from an earlier bundle.

string
/[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}/
Example
{
  "uploadSessionId": "823d14c6-ef4e-4d72-932e-20d8ed422e3c",
  "files": [
    {
      "name": "index.html",
      "mime": "text/html",
      "size": 1240,
      "hash": "sha256:6f1c"
    },
    {
      "name": "assets/app.js",
      "mime": "application/javascript",
      "size": 8300,
      "hash": "sha256:9b02"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Ok

Media typeapplication/json

A working code graphic.

id is the row identifier of the working copy. It changes on every publish. stateMachine holds the runtime, the control variables and the user expressions. lock is null when no one holds the graphic.

object
graphicId
required

Stable graphic identifier. It does not change between versions.

string
id
required

Entity identifier

integer format: int32
>= 1
name
required
string
type
required
string
Allowed values: code
version
required

Version number of the editable working copy.

integer format: int32
sports
required
Array<string>
stateMachine
required

Runtime, control variables and user expressions of a code graphic.

The index signature keeps the keys. tsoa strips every key of a Record<string, unknown>, because that type declares no properties.

object
key
additional properties
assets
required

Files of the bundle, sorted by name.

Array<object>
object
name
required

Path of the file inside the bundle, for example assets/app.js.

string
mime
required

Content type recorded for the file.

string
size
required

Size of the file in bytes.

integer format: int32
hash
required

Content hash the client sent. Compare it to skip an unchanged upload.

string
version
required

Revision counter of this file. It increases every time the hash changes.

integer format: int32
updatedAt
required

Time of the last change, in ISO 8601.

string
publishedVersions
required

Published version numbers, in ascending order.

Array<integer>
lock
required
object
userName
required

Name of the lock holder. An API key shows as API key <name>.

string
Example
{
  "type": "code"
}

400

Section titled “400”

The code graphic breaks a rule

Media typeapplication/json

Body of a 400 answer for a code graphic the service refuses.

code is always CODE_GRAPHIC_INVALID. details lists every broken rule. A malformed request body returns the ValidationError shape instead.

object
message
required
string
code
required
string
details
required
Array<string>
Examplegenerated
{
  "message": "example",
  "code": "example",
  "details": [
    "example"
  ]
}

401

Section titled “401”

Missing or invalid api key

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

403

Section titled “403”

Api key provides insufficient access for the request

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

404

Section titled “404”

Theme or graphic not found

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

409

Section titled “409”

The graphic is locked by another editor

Media typeapplication/json

Body of a 409 answer. The graphic is open in another editor.

code is always LOCKED. holder is null when the lock expired between the check and the answer.

object
message
required
string
code
required
string
holder
required
object
userName
required

Name of the lock holder. An API key shows as API key <name>.

string
Examplegenerated
{
  "message": "example",
  "code": "example",
  "holder": {
    "userName": "example"
  }
}

429

Section titled “429”

Api key has made too many requests

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}

500

Section titled “500”

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json
object
message
required
string
Examplegenerated
{
  "message": "example"
}