Skip to content

SDK: review

The review methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types.

Updated View as MarkdownOpen in ChatGPTOpen in Claude

The review 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).

reviewFindingsAutofix

Apply a finding’s suggested fix

  • Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/review/findings/{findingId}/autofix
reviewFindingsAutofix(args: { tenantId: string; projectId: string; findingId: string; body: AutofixRequest }, options?: CallOptions): Promise<AutofixResponse>

reviewFindingsFeedback

Give feedback on a finding

  • Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/review/findings/{findingId}/feedback
reviewFindingsFeedback(args: { tenantId: string; projectId: string; findingId: string; body: FeedbackRequest }, options?: CallOptions): Promise<FeedbackResponse>

reviewFindingsList

List review findings

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/review/findings
reviewFindingsList(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ReviewFindingsResponse>

reviewRunsCreate

Start an AI review run

  • Request: POST on /v1/tenants/{tenantId}/projects/{projectId}/review/runs
reviewRunsCreate(args: { tenantId: string; projectId: string; body: ReviewRunRequest }, options?: CallOptions): Promise<ReviewRunResponse>

reviewSettingsGet

Read a project’s review settings

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/review/settings
reviewSettingsGet(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ReviewSettings>

reviewSettingsPut

Change a project’s review settings

  • Request: PUT on /v1/tenants/{tenantId}/projects/{projectId}/review/settings
reviewSettingsPut(args: { tenantId: string; projectId: string; body: UpdateReviewSettingsRequest }, options?: CallOptions): Promise<ReviewSettings>

reviewStatus

Review status for a project

  • Request: GET on /v1/tenants/{tenantId}/projects/{projectId}/review/status
reviewStatus(args: { tenantId: string; projectId: string }, options?: CallOptions): Promise<ReviewStatusResponse>
Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.