Timeline Reviewed Event

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
event	string
id	integer	Unique identifier of the review
node_id	string
user	object
body	string	The text of the review.
state	string
html_url	string
pull_request_url	string
_links	object
submitted_at	string
commit_id	string	A commit SHA for the review.
body_html	string
body_text	string
author_association	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/timeline-reviewed-event",
  "title": "Timeline Reviewed Event",
  "description": "Timeline Reviewed Event",
  "type": "object",
  "properties": {
    "event": {
      "type": "string"
    },
    "id": {
      "description": "Unique identifier of the review",
      "example": 42,
      "type": "integer"
    },
    "node_id": {
      "type": "string",
      "example": "MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA="
    },
    "user": {
      "$ref": "#/components/schemas/simple-user"
    },
    "body": {
      "nullable": true,
      "description": "The text of the review.",
      "example": "This looks great.",
      "type": "string"
    },
    "state": {
      "type": "string",
      "example": "CHANGES_REQUESTED"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80"
    },
    "pull_request_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/pulls/12"
    },
    "_links": {
      "type": "object",
      "properties": {
        "html": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        },
        "pull_request": {
          "type": "object",
          "properties": {
            "href": {
              "type": "string"
            }
          },
          "required": [
            "href"
          ]
        }
      },
      "required": [
        "html",
        "pull_request"
      ]
    },
    "submitted_at": {
      "type": "string",
      "format": "date-time"
    },
    "commit_id": {
      "description": "A commit SHA for the review.",
      "example": "54bb654c9e6025347f57900a4a5c2313a96b8035",
      "type": "string"
    },
    "body_html": {
      "type": "string"
    },
    "body_text": {
      "type": "string"
    },
    "author_association": {
      "$ref": "#/components/schemas/author-association"
    }
  },
  "required": [
    "event",
    "id",
    "node_id",
    "user",
    "body",
    "state",
    "commit_id",
    "html_url",
    "pull_request_url",
    "_links",
    "author_association"
  ]
}