report_annotation

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/report_annotation",
  "title": "report_annotation",
  "allOf": [
    {
      "$ref": "#/components/schemas/object"
    },
    {
      "additionalProperties": true,
      "type": "object",
      "title": "Report Annotation",
      "description": "A report for a commit.",
      "properties": {
        "external_id": {
          "type": "string",
          "description": "ID of the annotation provided by the annotation creator. It can be used to identify the annotation as an alternative to it's generated uuid. It is not used by Bitbucket, but only by the annotation creator for updating or deleting this specific annotation. Needs to be unique."
        },
        "uuid": {
          "type": "string",
          "description": "The UUID that can be used to identify the annotation."
        },
        "annotation_type": {
          "enum": [
            "VULNERABILITY",
            "CODE_SMELL",
            "BUG"
          ],
          "type": "string",
          "description": "The type of the report."
        },
        "path": {
          "type": "string",
          "description": "The path of the file on which this annotation should be placed. This is the path of the file relative to the git repository. If no path is provided, then it will appear in the overview modal on all pull requests where the tip of the branch is the given commit, regardless of which files were modified."
        },
        "line": {
          "type": "integer",
          "description": "The line number that the annotation should belong to. If no line number is provided, then it will default to 0 and in a pull request it will appear at the top of the file specified by the path field.",
          "minimum": 1
        },
        "summary": {
          "type": "string",
          "description": "The message to display to users."
        },
        "details": {
          "type": "string",
          "description": "The details to show to users when clicking on the annotation."
        },
        "result": {
          "enum": [
            "PASSED",
            "FAILED",
            "SKIPPED",
            "IGNORED"
          ],
          "type": "string",
          "description": "The state of the report. May be set to PENDING and later updated."
        },
        "severity": {
          "enum": [
            "CRITICAL",
            "HIGH",
            "MEDIUM",
            "LOW"
          ],
          "type": "string",
          "description": "The severity of the annotation."
        },
        "link": {
          "type": "string",
          "format": "uri",
          "description": "A URL linking to the annotation in an external tool."
        },
        "created_on": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the report was created."
        },
        "updated_on": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the report was updated."
        }
      }
    }
  ],
  "x-bb-default-fields": [
    "uuid"
  ],
  "x-bb-url": "/rest/2.0/accounts/{target_user.uuid}/repositories/{repository.uuid}/commits/{commit.hash}/reports/{reportUuid}/annotations/{uuid}"
}