GitHubCheckSuiteEventModel#

pydantic model safir.github.webhooks.GitHubCheckSuiteEventModel#

A Pydantic model for the check_suite webhook payload.

https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite

Parameters:

data (Any) –

Show JSON schema
{
   "title": "GitHubCheckSuiteEventModel",
   "description": "A Pydantic model for the ``check_suite`` webhook payload.\n\nhttps://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payloads#check_suite",
   "type": "object",
   "properties": {
      "action": {
         "description": "The action performed.",
         "allOf": [
            {
               "$ref": "#/definitions/GitHubCheckSuiteEventAction"
            }
         ]
      },
      "check_suite": {
         "title": "Check Suite",
         "description": "Information about the check suite.",
         "allOf": [
            {
               "$ref": "#/definitions/GitHubCheckSuiteModel"
            }
         ]
      },
      "repository": {
         "title": "Repository",
         "description": "The repository that the check suite was run against.",
         "allOf": [
            {
               "$ref": "#/definitions/GitHubRepositoryModel"
            }
         ]
      },
      "installation": {
         "title": "Installation",
         "description": "Information about the GitHub App installation.",
         "allOf": [
            {
               "$ref": "#/definitions/GitHubAppInstallationModel"
            }
         ]
      }
   },
   "required": [
      "action",
      "check_suite",
      "repository",
      "installation"
   ],
   "definitions": {
      "GitHubCheckSuiteEventAction": {
         "title": "GitHubCheckSuiteEventAction",
         "description": "The action performed in a GitHub ``check_suite`` webhook\n(`GitHubCheckSuiteEventModel`).",
         "enum": [
            "completed",
            "requested",
            "rerequested"
         ],
         "type": "string"
      },
      "GitHubCheckSuiteStatus": {
         "title": "GitHubCheckSuiteStatus",
         "description": "The status of a GitHub check suite.",
         "enum": [
            "queued",
            "in_progress",
            "completed"
         ],
         "type": "string"
      },
      "GitHubCheckSuiteConclusion": {
         "title": "GitHubCheckSuiteConclusion",
         "description": "The conclusion state of a GitHub check suite.",
         "enum": [
            "success",
            "failure",
            "neutral",
            "cancelled",
            "timed_out",
            "action_required",
            "stale"
         ],
         "type": "string"
      },
      "GitHubCheckSuiteModel": {
         "title": "GitHubCheckSuiteModel",
         "description": "A Pydantic model for the ``check_suite`` field in a ``check_suite``\nwebhook (`~safir.github.webhooks.GitHubCheckSuiteEventModel`).",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "description": "Identifier for this check run.",
               "type": "string"
            },
            "head_branch": {
               "title": "Head Branch",
               "description": "Name of the branch the changes are on.",
               "type": "string"
            },
            "head_sha": {
               "title": "Head Sha",
               "description": "The SHA of the most recent commit for this check suite.",
               "type": "string"
            },
            "url": {
               "title": "Url",
               "description": "GitHub API URL for the check suite resource.",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "status": {
               "description": "The status of the check suite.",
               "allOf": [
                  {
                     "$ref": "#/definitions/GitHubCheckSuiteStatus"
                  }
               ]
            },
            "conclusion": {
               "description": "The conclusion of the check suite.",
               "allOf": [
                  {
                     "$ref": "#/definitions/GitHubCheckSuiteConclusion"
                  }
               ]
            }
         },
         "required": [
            "id",
            "head_branch",
            "head_sha",
            "url",
            "status"
         ]
      },
      "GitHubRepoOwnerModel": {
         "title": "GitHubRepoOwnerModel",
         "description": "A Pydantic model for the ``owner`` field found in repository objects.\n\nhttps://docs.github.com/en/rest/repos/repos#get-a-repository",
         "type": "object",
         "properties": {
            "login": {
               "title": "Login name",
               "description": "Login name of the owner (either a user or an organization).",
               "example": "lsst-sqre",
               "type": "string"
            }
         },
         "required": [
            "login"
         ]
      },
      "GitHubRepositoryModel": {
         "title": "GitHubRepositoryModel",
         "description": "A Pydantic model for the ``repository`` field, often found in webhook\npayloads.\n\nhttps://docs.github.com/en/rest/repos/repos#get-a-repository",
         "type": "object",
         "properties": {
            "name": {
               "title": "Repository name",
               "description": "Excludes owner prefix.",
               "example": "times-square-demo",
               "type": "string"
            },
            "full_name": {
               "title": "Full name",
               "description": "Full name, including owner prefix (e.g. ``lsst-sqre/times-square-demo``).)",
               "example": "lsst-sqre/times-square-demo",
               "type": "string"
            },
            "owner": {
               "title": "Owner",
               "description": "The repository's owner.",
               "allOf": [
                  {
                     "$ref": "#/definitions/GitHubRepoOwnerModel"
                  }
               ]
            },
            "default_branch": {
               "title": "Default Branch",
               "description": "The default branch (e.g. main).",
               "example": "main",
               "type": "string"
            },
            "html_url": {
               "title": "Html Url",
               "description": "URL of the repository for browsers.",
               "example": "https://github.com/lsst-sqre/times-square-demo",
               "minLength": 1,
               "maxLength": 2083,
               "format": "uri",
               "type": "string"
            },
            "branches_url": {
               "title": "Branches Url",
               "description": "URI template for the repo's branches endpoint.",
               "example": "https://github.com/lsst-sqre/times-square-demo/branches{/branch}",
               "type": "string"
            },
            "contents_url": {
               "title": "Contents Url",
               "description": "URI template for the contents endpoint.",
               "example": "https://github.com/lsst-sqre/times-square-demo/contents/{+path}",
               "type": "string"
            },
            "trees_url": {
               "title": "Trees Url",
               "description": "URI template for the Git tree API.",
               "example": "https://github.com/lsst-sqre/times-square-demo/git/trees{/sha}",
               "type": "string"
            },
            "blobs_url": {
               "title": "Blobs Url",
               "description": "URI template for the Git blobs API.",
               "example": "https://github.com/lsst-sqre/times-square-demo/git/blobs{/sha}",
               "type": "string"
            }
         },
         "required": [
            "name",
            "full_name",
            "owner",
            "default_branch",
            "html_url",
            "branches_url",
            "contents_url",
            "trees_url",
            "blobs_url"
         ]
      },
      "GitHubAppInstallationModel": {
         "title": "GitHubAppInstallationModel",
         "description": "A Pydantic model for the ``installation`` field found in webhook\npayloads for GitHub Apps.",
         "type": "object",
         "properties": {
            "id": {
               "title": "Id",
               "description": "The installation ID.",
               "type": "string"
            }
         },
         "required": [
            "id"
         ]
      }
   }
}

Fields:
field action: GitHubCheckSuiteEventAction [Required]#

The action performed.

field check_suite: GitHubCheckSuiteModel [Required]#

Information about the check suite.

field installation: GitHubAppInstallationModel [Required]#

Information about the GitHub App installation.

field repository: GitHubRepositoryModel [Required]#

The repository that the check suite was run against.