Docs

API

Every endpoint, with its signature and parameters. Base URL: https://gaborvilics.be/api/docs

List categories

function
GET /api/docs/categories

All categories, ordered by sortOrder.

List projects

function
GET /api/docs/projects

Project summaries.

Get project

function
GET /api/docs/projects/{id}

Full project payload (the project-kind page).

PropTypeRequiredDescription
idstring (path)YesProject id

Resolve

function
GET /api/docs/resolve?path=

Resolve any path to { kind, data }. 404 if unknown.

PropTypeRequiredDescription
pathstring (query)YesSite path, e.g. /docs-api/overview
function
GET /api/docs/search?q=

Search projects and pages.

PropTypeRequiredDescription
qstring (query)YesQuery string

Create page

function
POST /api/docs/admin/pages

Create a page. 409 if the path already exists.

PropTypeRequiredDescription
pathstringYesUnique site path
kindstringYesPage kind
projectIdstring?—Owning project
datajsonYesVerbatim payload

Update page

function
PUT /api/docs/admin/pages/{*path}

Replace a page's kind, projectId and data by path.

PropTypeRequiredDescription
pathstring (catch-all)YesExisting page path

Delete page

function
DELETE /api/docs/admin/pages/{*path}

Delete a page by path.

PropTypeRequiredDescription
pathstring (catch-all)YesExisting page path

Create project

function
POST /api/docs/admin/projects

Create a project summary row.

Create category

function
POST /api/docs/admin/categories

Create a category.