List Documents as code

List the Documents you can view, in code representation

GET /api/v1/projects/{projectUuid}/code/documents

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "nextOffset": 123,
    "missingSlugs": [
      "<string>"
    ],
    "documents": [
      {
        "description": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "schemaVersion": 2,
        "spaceSlug": "<string>",
        "charts": {},
        "markdown": "<string>",
        "unsupportedCharts": {}
      }
    ]
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

Query Parameters

slugs · string[]

offset · number<double>

schemaVersion · number<double>

The newest Document schema version the client reads. An older version is refused with an upgrade message.

Response

200

application/json

Success

results · object · required

Show child attributes

status · enum<string> · required

Available options: ok