Automatically assign reviewers to meet review requirements (By ID)

Request

POST

https://api.sourcecraft.tech/pulls/id:{pull_request_id}/reviewers/auto

Path parameters

Name

Description

pull_request_id

Type: string

Example: ``

Query parameters

Name

Description

pull_request_slug

Type: string

Example: ``

Body

application/json
{
  "silent": true
}

Name

Description

silent

Type: boolean

Responses

200 OK

A successful response.

Body

application/json
{
  "reviewers_delta": [
    {
      "action": "add",
      "user": {
        "id": "example",
        "slug": "example"
      }
    }
  ]
}

Name

Description

reviewers_delta

Type: AutoAssignResponse.ReviewerDelta[]

Example
[
  {
    "action": "add",
    "user": {
      "id": "example",
      "slug": "example"
    }
  }
]

DeltaAction

Type: string

Enum: add, remove

UserEmbedded

Name

Description

id

Type: string

Example: example

slug

Type: string

Example: example

Example
{
  "id": "example",
  "slug": "example"
}

AutoAssignResponse.ReviewerDelta

Name

Description

action

Type: DeltaAction

Enum: add, remove

user

Type: UserEmbedded

Example
{
  "id": "example",
  "slug": "example"
}
Example
{
  "action": "add",
  "user": {
    "id": "example",
    "slug": "example"
  }
}

default

Both Client Errors (4xx) and Server Errors (5xx) are serialized into this scheme

Body

application/json
{
  "error_code": "example",
  "message": "example",
  "request_id": "example",
  "details": {}
}

Name

Description

details

Type: Optional details. Exact structure depends on error_code

[additional]

Type: string

Example: example

Example
{}

error_code

Type: string

Example: example

message

Type: string

Example: example

request_id

Type: string

Example: example

Предыдущая
Следующая