Run code review for a patch

v1.0.0

Trigger the code review of a patch. This is available for projects with Git repositories.

Your request must include:

Identifier for the base commit
Patch generated using git diff --binary (see )
Header Content-Type: application/octet-stream
For both LGTM.com and LGTM Enterprise, an access token with the codereviews:write scope

Note that if you make a request using Curl, you'll also need to add --data-binary to the request to ensure that the patch you supply in the body is sent with newlines unchanged. You can track the progress of the review using the task result URL returned on creation of the task, or by calling the /operations endpoint with the operations identifier returned by the request. For more information, see . Alternatively, if you supply a callback URL you'll get a post-back automatically on completion of the review.

When the review is complete, you can access the results using the task result URL.

Input

{
  "type": "object",
  "properties": {
    "base": {
      "type": "string"
    },
    "callback-secret": {
      "type": "string"
    },
    "callback-url": {
      "type": "string"
    },
    "external-id": {
      "type": "integer",
      "format": "int32"
    },
    "project-id": {
      "type": "integer",
      "format": "int64"
    },
    "review-url": {
      "type": "string"
    }
  },
  "required": [
    "base",
    "external-id",
    "project-id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "task-type"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "The identifier for the operation."
    },
    "status": {
      "type": "string",
      "description": "Status of the operation.",
      "enum": [
        "pending",
        "done"
      ]
    },
    "task-result": {
      "type": "object"
    },
    "task-result-url": {
      "type": "string",
      "description": "The URL for the result of the task. For some operations, included only on completion."
    },
    "task-type": {
      "type": "string",
      "enum": [
        "analysis",
        "codereview",
        "queryjob"
      ]
    },
    "uploads": {
      "type": "object"
    }
  }
}