Get all documents for a project

GET 
/api/v1/project/:projectIdentifier/docs

Get all documents for a project

Request

Path Parameters

projectIdentifier stringrequired

Project identifier (ID or name)

Responses

200

application/json

Schema

Schema

• Array [

name stringrequired

The name of the documentation

isUrl booleanrequired

Whether the documentation is an external URL

readme string

The content of the README if isUrl is false

docUrl string

The URL to the external documentation if isUrl is true

id numberrequired

Unique identifier of the documentation

createdAt date-timerequired

Timestamp when the doc was created

updatedAt date-timerequired

Timestamp when the doc was last updated

• ]

Example (from schema)

[
  {
    "name": "Project README",
    "isUrl": false,
    "readme": "# Project Documentation",
    "docUrl": "https://example.com/docs",
    "id": 1,
    "createdAt": "2025-02-03T12:34:56Z",
    "updatedAt": "2025-02-03T12:34:56Z"
  }
]

Loading...