SDK: code

The code area has 14 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).

codeLinksGet

Whether code lookups follow links into the team’s other repositories (on by default)

• Request: GET on /v1/tenants/{tenantId}/code/links

codeLinksGet(args: { tenantId: string }, options?: CallOptions): Promise<CodeLinksSetting>

codeLinksPut

Turn links between the team’s repositories on or off for code lookups; a caller sees linked code only from repositories it can read

• Request: PUT on /v1/tenants/{tenantId}/code/links

codeLinksPut(args: { tenantId: string; body: PutCodeLinks }, options?: CallOptions): Promise<CodeLinksSetting>

codeProjectQueryGet

Query the code index by project

• Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/code/{tool}

codeProjectQueryGet(args: { tenantId: string; projectId: string; tool: string }, options?: CallOptions): Promise<Record<string, unknown>>

codeProjectQueryPost

Query the code index by project

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/code/{tool}

codeProjectQueryPost(args: { tenantId: string; projectId: string; tool: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeProjectUploadDelete

Upload and manage code index snapshots by project

• Request: DELETE on /v1/tenants/{tenantId}/projects/{projectId}/snapshots

codeProjectUploadDelete(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<Record<string, unknown>>

codeProjectUploadPatch

Upload and manage code index snapshots by project

• Request: PATCH on /v1/tenants/{tenantId}/projects/{projectId}/snapshots

codeProjectUploadPatch(args: { tenantId: string; projectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeProjectUploadPost

Upload and manage code index snapshots by project

• Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/snapshots

codeProjectUploadPost(args: { tenantId: string; projectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeProjectUploadPut

Upload and manage code index snapshots by project

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

codeProjectUploadPut(args: { tenantId: string; projectId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeQueryGet

Query the code index by repository (find_symbol, trace_calls and the other tools)

• Request: GET on /v1/tenants/{tenantId}/repos/{owner}/{repo}/code/{tool}

codeQueryGet(args: { tenantId: string; owner: string; repo: string; tool: string }, options?: CallOptions): Promise<Record<string, unknown>>

codeQueryPost

Query the code index by repository (find_symbol, trace_calls and the other tools)

• Request: POST on /v1/tenants/{tenantId}/repos/{owner}/{repo}/code/{tool}

codeQueryPost(args: { tenantId: string; owner: string; repo: string; tool: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeUploadDelete

Upload and manage code index snapshots by repository

• Request: DELETE on /v1/tenants/{tenantId}/repos/{owner}/{repo}/snapshots

codeUploadDelete(args: { tenantId: string; owner: string; repo: string }, options?: CallOptions): Promise<Record<string, unknown>>

codeUploadPatch

Upload and manage code index snapshots by repository

• Request: PATCH on /v1/tenants/{tenantId}/repos/{owner}/{repo}/snapshots

codeUploadPatch(args: { tenantId: string; owner: string; repo: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeUploadPost

Upload and manage code index snapshots by repository

• Request: POST on /v1/tenants/{tenantId}/repos/{owner}/{repo}/snapshots

codeUploadPost(args: { tenantId: string; owner: string; repo: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

codeUploadPut

Upload and manage code index snapshots by repository

• Request: PUT on /v1/tenants/{tenantId}/repos/{owner}/{repo}/snapshots

codeUploadPut(args: { tenantId: string; owner: string; repo: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>