SDK: docs

The docs area has 7 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

docsDependencies

The project’s pinned libraries: indexed, stale, private and missing

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/docs/dependencies

docsDependencies(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<DocsDependenciesResult>

docsIndex

Fetch and index a library’s official docs, or refresh an existing index

• Request: POST on /v1/tenants/{tenantId}/docs/index

docsIndex(args: { tenantId: string; body: DocsIndexRequest }, options?: CallOptions): Promise<DocsIndexResult>

docsLibraries

Library versions the team has indexed, with their age

• Request: GET on /v1/tenants/{tenantId}/docs/libraries

docsLibraries(args: { tenantId: string }, options?: CallOptions): Promise<DocsLibrariesResult>

docsPins

Read version pins from the project’s lockfiles (npm, pnpm, yarn, pip, uv, cargo, go)

• Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/docs/pins

docsPins(args: { tenantId: string; projectId: string; body: DocsPinsRequest }, options?: CallOptions): Promise<DocsPinsResult>

docsPrivate

Index the team’s own docs as a private library

• Request: POST on /v1/tenants/{tenantId}/docs/private

docsPrivate(args: { tenantId: string; body: DocsPrivateRequest }, options?: CallOptions): Promise<DocsPrivateResult>

docsQuery

Look up library docs at the pinned version; fetches and indexes the library on first use

• Request: POST on /v1/tenants/{tenantId}/docs/query

docsQuery(args: { tenantId: string; body: DocsQueryRequest }, options?: CallOptions): Promise<DocsQueryResult>

docsUsage

This month’s library docs calls against the team allowance

• Request: GET on /v1/tenants/{tenantId}/docs/usage

docsUsage(args: { tenantId: string }, options?: CallOptions): Promise<DocsUsageResult>