Upsert Document as code

Create or update a Document, matched by slug, from code representation

POST /api/v1/projects/{projectUuid}/code/documents/{slug}

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "action": "create"
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

slug · string · required

Body

application/json

Markdown with a <document-chart id="…"> block wherever a chart sits, and the charts those blocks reference. On writes, ids that are not c<n> are temporary keys the server replaces with the next free id.

description · string · required

name · string · required

slug · string · required

schemaVersion · enum<number> · required

Available options: 2

spaceSlug · string · required

charts · object · required

Charts by id. Stored ids are sequential per Document (c1, c2, …).

Show child attributes

markdown · string · required

unsupportedCharts · object

Charts saved by a newer release, kept verbatim so saving the Document here doesn't lose them. Omitted when there are none.

Show child attributes

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok