common.paths

API endpoint paths for Nildb client, matching the TypeScript NilDbEndpoint structure.

NilDbEndpointClass

alias of NilDbEndpoint

class v1

Version 1 API endpoints.

class builders

Endpoints for builder operations.

me = '/v1/builders/me'

register = '/v1/builders/register'

class collections

Endpoints for collection operations.

byId = '/v1/collections/:id'

indexesById = '/v1/collections/:id/indexes'

indexesByNameById = '/v1/collections/:id/indexes/:name'

root = '/v1/collections'

class data

Endpoints for data operations.

createOwned = '/v1/data/owned'

createStandard = '/v1/data/standard'

delete = '/v1/data/delete'

find = '/v1/data/find'

flushById = '/v1/data/:id/flush'

root = '/v1/data'

tailById = '/v1/data/:id/tail'

update = '/v1/data/update'

class queries

Endpoints for query operations.

byId = '/v1/queries/:id'

root = '/v1/queries'

run = '/v1/queries/run'

runById = '/v1/queries/run/:id'

class system

Endpoints for system operations and health checks.

about = '/about'

health = '/health'

logLevel = '/v1/system/log-level'

maintenanceStart = '/v1/system/maintenance/start'

maintenanceStop = '/v1/system/maintenance/stop'

metrics = '/metrics'

openApiJson = '/openapi.json'

class users

Endpoints for user operations.

class data

Endpoints for user data operations.

class acl

Endpoints for user data ACL operations.

grant = '/v1/users/data/acl/grant'

revoke = '/v1/users/data/acl/revoke'

aclById = '/v1/users/data/:collection/:document/acl'

byId = '/v1/users/data/:collection/:document'

root = '/v1/users/data'

me = '/v1/users/me'