GitHub

{
  "type": "object",
  "required": [
    "days"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "description": "The number of days to retain artifacts and logs"
    }
  }
}

{
  "type": "object",
  "required": [
    "days",
    "maximum_allowed_days"
  ],
  "properties": {
    "days": {
      "type": "integer",
      "description": "The number of days artifacts and logs are retained"
    },
    "maximum_allowed_days": {
      "type": "integer",
      "description": "The maximum number of days that can be configured"
    }
  }
}

{
  "type": "object",
  "title": "Repository actions caches",
  "required": [
    "total_count",
    "actions_caches"
  ],
  "properties": {
    "total_count": {
      "type": "integer",
      "example": 2,
      "description": "Total number of caches"
    },
    "actions_caches": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 2
          },
          "key": {
            "type": "string",
            "example": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b"
          },
          "ref": {
            "type": "string",
            "example": "refs/heads/main"
          },
          "version": {
            "type": "string",
            "example": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "example": "2019-01-24T22:45:36.000Z"
          },
          "size_in_bytes": {
            "type": "integer",
            "example": 1024
          },
          "last_accessed_at": {
            "type": "string",
            "format": "date-time",
            "example": "2019-01-24T22:45:36.000Z"
          }
        }
      },
      "description": "Array of caches"
    }
  },
  "description": "Repository actions caches"
}

{
  "type": "object",
  "title": "Actions cache retention limit for an enterprise",
  "properties": {
    "max_cache_retention_days": {
      "type": "integer",
      "example": 14,
      "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained."
    }
  },
  "description": "GitHub Actions cache retention policy for an enterprise."
}

{
  "type": "object",
  "title": "Actions cache retention limit for an organization",
  "properties": {
    "max_cache_retention_days": {
      "type": "integer",
      "example": 14,
      "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained."
    }
  },
  "description": "GitHub Actions cache retention policy for an organization."
}

{
  "type": "object",
  "title": "Actions cache retention limit for a repository",
  "properties": {
    "max_cache_retention_days": {
      "type": "integer",
      "example": 14,
      "description": "The maximum number of days to keep caches in this repository."
    }
  },
  "description": "GitHub Actions cache retention policy for a repository."
}

{
  "type": "object",
  "title": "Actions cache storage limit for an enterprise",
  "properties": {
    "max_cache_size_gb": {
      "type": "integer",
      "example": 10,
      "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes."
    }
  },
  "description": "GitHub Actions cache storage policy for an enterprise."
}

{
  "type": "object",
  "title": "Actions cache storage limit for an organization",
  "properties": {
    "max_cache_size_gb": {
      "type": "integer",
      "example": 10,
      "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes."
    }
  },
  "description": "GitHub Actions cache storage policy for an organization."
}

{
  "type": "object",
  "title": "Actions cache storage limit for a repository",
  "properties": {
    "max_cache_size_gb": {
      "type": "integer",
      "example": 10,
      "description": "The maximum total cache size for this repository, in gigabytes."
    }
  },
  "description": "GitHub Actions cache storage policy for a repository."
}

{
  "type": "object",
  "title": "Actions Cache Usage by repository",
  "required": [
    "full_name",
    "active_caches_size_in_bytes",
    "active_caches_count"
  ],
  "properties": {
    "full_name": {
      "type": "string",
      "example": "octo-org/Hello-World",
      "description": "The repository owner and name for the cache usage being shown."
    },
    "active_caches_count": {
      "type": "integer",
      "example": 3,
      "description": "The number of active caches in the repository."
    },
    "active_caches_size_in_bytes": {
      "type": "integer",
      "example": 2322142,
      "description": "The sum of the size in bytes of all the active cache items in the repository."
    }
  },
  "description": "GitHub Actions Cache Usage by repository."
}

{
  "type": "object",
  "required": [
    "total_active_caches_count",
    "total_active_caches_size_in_bytes"
  ],
  "properties": {
    "total_active_caches_count": {
      "type": "integer",
      "description": "The count of active caches across all repositories of an enterprise or an organization."
    },
    "total_active_caches_size_in_bytes": {
      "type": "integer",
      "description": "The total size in bytes of all active cache items across all repositories of an enterprise or an organization."
    }
  }
}

{
  "type": "boolean",
  "description": "Whether GitHub Actions can approve pull requests. Enabling this can be a security risk."
}

{
  "enum": [
    "read",
    "write"
  ],
  "type": "string",
  "description": "The default workflow permissions granted to the GITHUB_TOKEN when running workflows."
}

{
  "type": "boolean",
  "description": "Whether GitHub Actions is enabled on the repository."
}

{
  "type": "object",
  "required": [
    "approval_policy"
  ],
  "properties": {
    "approval_policy": {
      "enum": [
        "first_time_contributors_new_to_github",
        "first_time_contributors",
        "all_external_contributors"
      ],
      "type": "string",
      "description": "The policy that controls when fork PR workflows require approval from a maintainer."
    }
  }
}

{
  "type": "object",
  "required": [
    "run_workflows_from_fork_pull_requests",
    "send_write_tokens_to_workflows",
    "send_secrets_and_variables",
    "require_approval_for_fork_pr_workflows"
  ],
  "properties": {
    "send_secrets_and_variables": {
      "type": "boolean",
      "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks."
    },
    "send_write_tokens_to_workflows": {
      "type": "boolean",
      "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request."
    },
    "run_workflows_from_fork_pull_requests": {
      "type": "boolean",
      "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories."
    },
    "require_approval_for_fork_pr_workflows": {
      "type": "boolean",
      "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run."
    }
  }
}

{
  "type": "object",
  "required": [
    "run_workflows_from_fork_pull_requests"
  ],
  "properties": {
    "send_secrets_and_variables": {
      "type": "boolean",
      "description": "Whether to make secrets and variables available to workflows triggered by pull requests from forks."
    },
    "send_write_tokens_to_workflows": {
      "type": "boolean",
      "description": "Whether GitHub Actions can create pull requests or submit approving pull request reviews from a workflow triggered by a fork pull request."
    },
    "run_workflows_from_fork_pull_requests": {
      "type": "boolean",
      "description": "Whether workflows triggered by pull requests from forks are allowed to run on private repositories."
    },
    "require_approval_for_fork_pr_workflows": {
      "type": "boolean",
      "description": "Whether workflows triggered by pull requests from forks require approval from a repository administrator to run."
    }
  }
}

{
  "type": "object",
  "required": [
    "default_workflow_permissions",
    "can_approve_pull_request_reviews"
  ],
  "properties": {
    "default_workflow_permissions": {
      "$ref": "#/components/schemas/actions-default-workflow-permissions"
    },
    "can_approve_pull_request_reviews": {
      "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews"
    }
  }
}

{
  "type": "object",
  "title": "GitHub-hosted hosted runner",
  "required": [
    "id",
    "name",
    "image_details",
    "machine_size_details",
    "status",
    "public_ip_enabled",
    "platform"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 5,
      "description": "The unique identifier of the hosted runner."
    },
    "name": {
      "type": "string",
      "example": "my-github-hosted-runner",
      "description": "The name of the hosted runner."
    },
    "status": {
      "enum": [
        "Ready",
        "Provisioning",
        "Shutdown",
        "Deleting",
        "Stuck"
      ],
      "type": "string",
      "example": "Ready",
      "description": "The status of the runner."
    },
    "platform": {
      "type": "string",
      "example": "linux-x64",
      "description": "The operating system of the image."
    },
    "image_gen": {
      "type": "boolean",
      "description": "Whether custom image generation is enabled for the hosted runners."
    },
    "public_ips": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/public-ip"
      },
      "description": "The public IP ranges when public IP is enabled for the hosted runners."
    },
    "image_details": {
      "$ref": "#/components/schemas/nullable-actions-hosted-runner-pool-image"
    },
    "last_active_on": {
      "type": "string",
      "format": "date-time",
      "example": "2022-10-09T23:39:01Z",
      "nullable": true,
      "description": "The time at which the runner was last used, in ISO 8601 format."
    },
    "maximum_runners": {
      "type": "integer",
      "default": 10,
      "example": 5,
      "description": "The maximum amount of hosted runners. Runners will not scale automatically above this number. Use this setting to limit your cost."
    },
    "runner_group_id": {
      "type": "integer",
      "example": 2,
      "description": "The unique identifier of the group that the hosted runner belongs to."
    },
    "public_ip_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether public IP is enabled for the hosted runners."
    },
    "machine_size_details": {
      "$ref": "#/components/schemas/actions-hosted-runner-machine-spec"
    }
  },
  "description": "A Github-hosted hosted runner."
}

{
  "type": "object",
  "title": "GitHub-hosted runner image details.",
  "required": [
    "id",
    "platform",
    "size_gb",
    "display_name",
    "source"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "ubuntu-20.04",
      "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner."
    },
    "source": {
      "enum": [
        "github",
        "partner",
        "custom"
      ],
      "type": "string",
      "description": "The image provider."
    },
    "size_gb": {
      "type": "integer",
      "example": 86,
      "description": "Image size in GB."
    },
    "platform": {
      "type": "string",
      "example": "linux-x64",
      "description": "The operating system of the image."
    },
    "display_name": {
      "type": "string",
      "example": 20.04,
      "description": "Display name for this image."
    }
  },
  "description": "Provides details of a hosted runner image"
}

{
  "type": "object",
  "title": "GitHub-hosted runner custom image details",
  "required": [
    "id",
    "platform",
    "name",
    "source",
    "versions_count",
    "total_versions_size",
    "latest_version",
    "state"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 1,
      "description": "The ID of the image. Use this ID for the `image` parameter when creating a new larger runner."
    },
    "name": {
      "type": "string",
      "example": "CustomImage",
      "description": "Display name for this image."
    },
    "state": {
      "type": "string",
      "example": "Ready",
      "description": "The number of image versions associated with the image."
    },
    "source": {
      "type": "string",
      "example": "custom",
      "description": "The image provider."
    },
    "platform": {
      "type": "string",
      "example": "linux-x64",
      "description": "The operating system of the image."
    },
    "latest_version": {
      "type": "string",
      "example": "1.3.0",
      "description": "The latest image version associated with the image."
    },
    "versions_count": {
      "type": "integer",
      "example": 4,
      "description": "The number of image versions associated with the image."
    },
    "total_versions_size": {
      "type": "integer",
      "example": 200,
      "description": "Total size of all the image versions in GB."
    }
  },
  "description": "Provides details of a custom runner image"
}

{
  "type": "object",
  "title": "GitHub-hosted runner custom image version details.",
  "required": [
    "version",
    "state",
    "size_gb",
    "created_on",
    "state_details"
  ],
  "properties": {
    "state": {
      "type": "string",
      "example": "Ready",
      "description": "The state of image version."
    },
    "size_gb": {
      "type": "integer",
      "example": 30,
      "description": "Image version size in GB."
    },
    "version": {
      "type": "string",
      "example": "1.0.0",
      "description": "The version of image."
    },
    "created_on": {
      "type": "string",
      "example": "2024-11-09T23:39:01Z",
      "description": "The creation date time of the image version."
    },
    "state_details": {
      "type": "string",
      "example": "None",
      "description": "The image version status details."
    }
  },
  "description": "Provides details of a hosted runner custom image version"
}

{
  "type": "object",
  "required": [
    "public_ips"
  ],
  "properties": {
    "public_ips": {
      "type": "object",
      "title": "Static public IP Limits for GitHub-hosted Hosted Runners.",
      "required": [
        "maximum",
        "current_usage"
      ],
      "properties": {
        "maximum": {
          "type": "integer",
          "example": 50,
          "description": "The maximum number of static public IP addresses that can be used for Hosted Runners."
        },
        "current_usage": {
          "type": "integer",
          "example": 17,
          "description": "The current number of static public IP addresses in use by Hosted Runners."
        }
      },
      "description": "Provides details of static public IP limits for GitHub-hosted Hosted Runners"
    }
  }
}

{
  "type": "object",
  "title": "Github-owned VM details.",
  "required": [
    "id",
    "cpu_cores",
    "memory_gb",
    "storage_gb"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "8-core",
      "description": "The ID used for the `size` parameter when creating a new runner."
    },
    "cpu_cores": {
      "type": "integer",
      "example": 8,
      "description": "The number of cores."
    },
    "memory_gb": {
      "type": "integer",
      "example": 32,
      "description": "The available RAM for the machine spec."
    },
    "storage_gb": {
      "type": "integer",
      "example": 300,
      "description": "The available SSD storage for the machine spec."
    }
  },
  "description": "Provides details of a particular machine spec."
}

{
  "type": "object",
  "required": [
    "enabled_repositories"
  ],
  "properties": {
    "allowed_actions": {
      "$ref": "#/components/schemas/allowed-actions"
    },
    "enabled_repositories": {
      "$ref": "#/components/schemas/enabled-repositories"
    },
    "selected_actions_url": {
      "$ref": "#/components/schemas/selected-actions-url"
    },
    "sha_pinning_required": {
      "$ref": "#/components/schemas/sha-pinning-required"
    },
    "selected_repositories_url": {
      "type": "string",
      "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`."
    }
  }
}

{
  "type": "object",
  "title": "ActionsPublicKey",
  "required": [
    "key_id",
    "key"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 2
    },
    "key": {
      "type": "string",
      "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
      "description": "The Base64 encoded public key."
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/user/keys/2"
    },
    "title": {
      "type": "string",
      "example": "ssh-rsa AAAAB3NzaC1yc2EAAA"
    },
    "key_id": {
      "type": "string",
      "example": "1234567",
      "description": "The identifier for the key."
    },
    "created_at": {
      "type": "string",
      "example": "2011-01-26T19:01:12Z"
    }
  },
  "description": "The public key used for setting Actions Secrets."
}

{
  "type": "object",
  "required": [
    "enabled"
  ],
  "properties": {
    "enabled": {
      "$ref": "#/components/schemas/actions-enabled"
    },
    "allowed_actions": {
      "$ref": "#/components/schemas/allowed-actions"
    },
    "selected_actions_url": {
      "$ref": "#/components/schemas/selected-actions-url"
    },
    "sha_pinning_required": {
      "$ref": "#/components/schemas/sha-pinning-required"
    }
  }
}

{
  "type": "object",
  "title": "Actions Secret",
  "required": [
    "name",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "SECRET_TOKEN",
      "description": "The name of the secret."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "description": "Set secrets for GitHub Actions."
}

{
  "type": "object",
  "properties": {
    "default_workflow_permissions": {
      "$ref": "#/components/schemas/actions-default-workflow-permissions"
    },
    "can_approve_pull_request_reviews": {
      "$ref": "#/components/schemas/actions-can-approve-pull-request-reviews"
    }
  }
}

{
  "type": "object",
  "title": "Actions Variable",
  "required": [
    "name",
    "value",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "USERNAME",
      "description": "The name of the variable."
    },
    "value": {
      "type": "string",
      "example": "octocat",
      "description": "The value of the variable."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-01-24T22:45:36.000Z",
      "description": "The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2019-01-24T22:45:36.000Z",
      "description": "The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    }
  }
}

{
  "type": "object",
  "required": [
    "access_level"
  ],
  "properties": {
    "access_level": {
      "enum": [
        "none",
        "user",
        "organization"
      ],
      "type": "string",
      "description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository.\n\n`none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization."
    }
  }
}

{
  "type": "object",
  "title": "Activity",
  "required": [
    "id",
    "node_id",
    "before",
    "after",
    "ref",
    "timestamp",
    "activity_type",
    "actor"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 1296269
    },
    "ref": {
      "type": "string",
      "example": "refs/heads/main",
      "description": "The full Git reference, formatted as `refs/heads/<branch name>`."
    },
    "actor": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "after": {
      "type": "string",
      "example": "827efc6d56897b048c772eb4087f854f46256132",
      "description": "The SHA of the commit after the activity."
    },
    "before": {
      "type": "string",
      "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e",
      "description": "The SHA of the commit before the activity."
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:06:43Z",
      "description": "The time when the activity occurred."
    },
    "activity_type": {
      "enum": [
        "push",
        "force_push",
        "branch_deletion",
        "branch_creation",
        "pr_merge",
        "merge_queue_merge"
      ],
      "type": "string",
      "example": "force_push",
      "description": "The type of the activity that was performed."
    }
  },
  "description": "Activity"
}

{
  "type": "object",
  "title": "Actor",
  "required": [
    "id",
    "login",
    "gravatar_id",
    "url",
    "avatar_url"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "login": {
      "type": "string"
    },
    "avatar_url": {
      "type": "string",
      "format": "uri"
    },
    "gravatar_id": {
      "type": "string",
      "nullable": true
    },
    "display_login": {
      "type": "string"
    }
  },
  "description": "Actor"
}

{
  "type": "object",
  "title": "Added to Project Issue Event",
  "required": [
    "id",
    "node_id",
    "url",
    "actor",
    "event",
    "commit_id",
    "commit_url",
    "created_at",
    "performed_via_github_app"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string"
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "event": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "commit_id": {
      "type": "string",
      "nullable": true
    },
    "commit_url": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "project_card": {
      "type": "object",
      "required": [
        "id",
        "url",
        "project_id",
        "project_url",
        "column_name"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "project_id": {
          "type": "integer"
        },
        "column_name": {
          "type": "string"
        },
        "project_url": {
          "type": "string",
          "format": "uri"
        },
        "previous_column_name": {
          "type": "string"
        }
      }
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "description": "Added to Project Issue Event"
}

{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "readOnly": true,
  "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "string",
  "format": "date-time",
  "readOnly": true,
  "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "readOnly": true,
  "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "readOnly": true,
  "description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "string",
  "format": "uri",
  "readOnly": true,
  "description": "The GitHub URL of the alert resource."
}

{
  "type": "string",
  "format": "uri",
  "readOnly": true,
  "description": "The REST API URL for fetching the list of instances for an alert."
}

{
  "type": "integer",
  "readOnly": true,
  "description": "The security alert number."
}

{
  "type": "string",
  "format": "date-time",
  "readOnly": true,
  "description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "string",
  "format": "uri",
  "readOnly": true,
  "description": "The REST API URL of the alert resource."
}

{
  "enum": [
    "all",
    "local_only",
    "selected"
  ],
  "type": "string",
  "description": "The permissions policy that controls the actions and reusable workflows that are allowed to run."
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "api_route": {
        "type": "string",
        "description": "The API path's route template"
      },
      "http_method": {
        "type": "string",
        "description": "The HTTP method"
      },
      "total_request_count": {
        "type": "integer",
        "format": "int64",
        "description": "The total number of requests within the queried time period"
      },
      "last_request_timestamp": {
        "type": "string"
      },
      "rate_limited_request_count": {
        "type": "integer",
        "format": "int64",
        "description": "The total number of requests that were rate limited within the queried time period"
      },
      "last_rate_limited_timestamp": {
        "type": "string",
        "nullable": true
      }
    }
  },
  "title": "Route Stats",
  "description": "API Insights usage route stats for an actor"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "subject_id": {
        "type": "integer",
        "format": "int64"
      },
      "subject_name": {
        "type": "string"
      },
      "subject_type": {
        "type": "string"
      },
      "total_request_count": {
        "type": "integer"
      },
      "last_request_timestamp": {
        "type": "string"
      },
      "rate_limited_request_count": {
        "type": "integer"
      },
      "last_rate_limited_timestamp": {
        "type": "string",
        "nullable": true
      }
    }
  },
  "title": "Subject Stats",
  "description": "API Insights usage subject stats for an organization"
}

{
  "type": "object",
  "title": "Summary Stats",
  "properties": {
    "total_request_count": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of requests within the queried time period"
    },
    "rate_limited_request_count": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of requests that were rate limited within the queried time period"
    }
  },
  "description": "API Insights usage summary stats for an organization"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "timestamp": {
        "type": "string"
      },
      "total_request_count": {
        "type": "integer",
        "format": "int64"
      },
      "rate_limited_request_count": {
        "type": "integer",
        "format": "int64"
      }
    }
  },
  "title": "Time Stats",
  "description": "API Insights usage time stats for an organization"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "actor_id": {
        "type": "integer",
        "format": "int64"
      },
      "actor_name": {
        "type": "string"
      },
      "actor_type": {
        "type": "string"
      },
      "integration_id": {
        "type": "integer",
        "format": "int64",
        "nullable": true
      },
      "total_request_count": {
        "type": "integer"
      },
      "oauth_application_id": {
        "type": "integer",
        "format": "int64",
        "nullable": true
      },
      "last_request_timestamp": {
        "type": "string"
      },
      "rate_limited_request_count": {
        "type": "integer"
      },
      "last_rate_limited_timestamp": {
        "type": "string",
        "nullable": true
      }
    }
  },
  "title": "User Stats",
  "description": "API Insights usage stats for a user"
}

{
  "type": "object",
  "title": "Api Overview",
  "required": [
    "verifiable_password_authentication"
  ],
  "properties": {
    "api": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "git": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "web": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "hooks": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "pages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "actions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "copilot": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "domains": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "copilot": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "website": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "packages": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "codespaces": {
          "type": "array",
          "items": {
            "type": "string",
            "example": [
              "example.com"
            ]
          }
        },
        "actions_inbound": {
          "type": "object",
          "properties": {
            "full_domains": {
              "type": "array",
              "items": {
                "type": "string",
                "example": [
                  "example.com"
                ]
              }
            },
            "wildcard_domains": {
              "type": "array",
              "items": {
                "type": "string",
                "example": [
                  "example.com"
                ]
              }
            }
          }
        },
        "artifact_attestations": {
          "type": "object",
          "properties": {
            "services": {
              "type": "array",
              "items": {
                "type": "string",
                "example": [
                  "example.com"
                ]
              }
            },
            "trust_domain": {
              "type": "string",
              "example": [
                "example"
              ]
            }
          }
        }
      }
    },
    "importer": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "packages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "ssh_keys": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "ssh-ed25519 ABCDEFGHIJKLMNOPQRSTUVWXYZ"
      ]
    },
    "codespaces": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "dependabot": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "actions_macos": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "ssh_key_fingerprints": {
      "type": "object",
      "properties": {
        "SHA256_DSA": {
          "type": "string"
        },
        "SHA256_RSA": {
          "type": "string"
        },
        "SHA256_ECDSA": {
          "type": "string"
        },
        "SHA256_ED25519": {
          "type": "string"
        }
      }
    },
    "github_enterprise_importer": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "192.0.2.1"
      ]
    },
    "verifiable_password_authentication": {
      "type": "boolean",
      "example": true
    }
  },
  "description": "Api Overview"
}

{
  "type": "object",
  "title": "App Permissions",
  "example": {
    "issues": "read",
    "contents": "read",
    "deployments": "write",
    "single_file": "read"
  },
  "properties": {
    "pages": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds."
    },
    "checks": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for checks on code."
    },
    "issues": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones."
    },
    "actions": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts."
    },
    "members": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for organization teams and members."
    },
    "profile": {
      "enum": [
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the profile settings belonging to a user."
    },
    "secrets": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage repository secrets."
    },
    "contents": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges."
    },
    "gpg_keys": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage GPG keys belonging to a user."
    },
    "metadata": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata."
    },
    "packages": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for packages published to GitHub Packages."
    },
    "starring": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to list and manage repositories a user is starring."
    },
    "statuses": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for commit statuses."
    },
    "followers": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the followers belonging to a user."
    },
    "workflows": {
      "enum": [
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to update GitHub Actions workflow files."
    },
    "codespaces": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces."
    },
    "deployments": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for deployments and deployment statuses."
    },
    "discussions": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for discussions and related comments and labels."
    },
    "single_file": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage just a single file."
    },
    "attestations": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to create and retrieve the access token for repository attestations."
    },
    "environments": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for managing repository environments."
    },
    "git_ssh_keys": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage git SSH keys."
    },
    "merge_queues": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the merge queues for a repository."
    },
    "pull_requests": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges."
    },
    "administration": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation."
    },
    "email_addresses": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the email addresses belonging to a user."
    },
    "security_events": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts."
    },
    "repository_hooks": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository."
    },
    "artifact_metadata": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records."
    },
    "organization_plan": {
      "enum": [
        "read"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for viewing an organization's plan."
    },
    "dependabot_secrets": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage Dependabot secrets."
    },
    "interaction_limits": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage interaction limits on a repository."
    },
    "organization_hooks": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization."
    },
    "organization_events": {
      "enum": [
        "read"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view events triggered by an activity in an organization."
    },
    "repository_projects": {
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage repository projects, columns, and cards."
    },
    "organization_secrets": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage organization secrets."
    },
    "vulnerability_alerts": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage Dependabot alerts."
    },
    "organization_packages": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for organization packages published to GitHub Packages."
    },
    "organization_projects": {
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage organization projects and projects public preview (where available)."
    },
    "secret_scanning_alerts": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage secret scanning alerts."
    },
    "organization_custom_roles": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for custom repository roles management."
    },
    "organization_user_blocking": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage users blocked by the organization."
    },
    "organization_administration": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to manage access to an organization."
    },
    "repository_custom_properties": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property."
    },
    "organization_custom_org_roles": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for custom organization roles management."
    },
    "organization_custom_properties": {
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for repository custom properties management at the organization level."
    },
    "organization_self_hosted_runners": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization."
    },
    "organization_announcement_banners": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage announcement banners for an organization."
    },
    "custom_properties_for_organizations": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property."
    },
    "organization_copilot_agent_settings": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token to view and manage Copilot coding agent settings for an organization."
    },
    "organization_personal_access_tokens": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization."
    },
    "organization_copilot_seat_management": {
      "enum": [
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in public preview and is subject to change."
    },
    "organization_personal_access_token_requests": {
      "enum": [
        "read",
        "write"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization."
    },
    "enterprise_custom_properties_for_organizations": {
      "enum": [
        "read",
        "write",
        "admin"
      ],
      "type": "string",
      "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level."
    }
  },
  "description": "The permissions granted to the user access token."
}

{
  "type": "object",
  "title": "Artifact",
  "required": [
    "id",
    "node_id",
    "name",
    "size_in_bytes",
    "url",
    "archive_download_url",
    "expired",
    "created_at",
    "expires_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 5
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5"
    },
    "name": {
      "type": "string",
      "example": "AdventureWorks.Framework",
      "description": "The name of the artifact."
    },
    "digest": {
      "type": "string",
      "example": "sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c",
      "nullable": true,
      "description": "The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null."
    },
    "expired": {
      "type": "boolean",
      "description": "Whether or not the artifact has expired."
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkNoZWNrU3VpdGU1"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "workflow_run": {
      "type": "object",
      "nullable": true,
      "properties": {
        "id": {
          "type": "integer",
          "example": 10
        },
        "head_sha": {
          "type": "string",
          "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"
        },
        "head_branch": {
          "type": "string",
          "example": "main"
        },
        "repository_id": {
          "type": "integer",
          "example": 42
        },
        "head_repository_id": {
          "type": "integer",
          "example": 42
        }
      }
    },
    "size_in_bytes": {
      "type": "integer",
      "example": 12345,
      "description": "The size in bytes of the artifact."
    },
    "archive_download_url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip"
    }
  },
  "description": "An artifact"
}

{
  "type": "object",
  "title": "Artifact Deployment Record",
  "properties": {
    "id": {
      "type": "integer"
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "digest": {
      "type": "string"
    },
    "cluster": {
      "type": "string"
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "runtime_risks": {
      "type": "array",
      "items": {
        "enum": [
          "critical-resource",
          "internet-exposed",
          "lateral-movement",
          "sensitive-data"
        ],
        "type": "string"
      },
      "maxItems": 4,
      "description": "A list of runtime risks associated with the deployment.",
      "uniqueItems": true
    },
    "attestation_id": {
      "type": "integer",
      "nullable": true,
      "description": "The ID of the provenance attestation associated with the deployment record."
    },
    "deployment_name": {
      "type": "string"
    },
    "logical_environment": {
      "type": "string"
    },
    "physical_environment": {
      "type": "string"
    }
  },
  "description": "Artifact Metadata Deployment Record"
}

{
  "type": "object",
  "title": "Assigned Issue Event",
  "required": [
    "id",
    "node_id",
    "url",
    "actor",
    "event",
    "commit_id",
    "commit_url",
    "created_at",
    "performed_via_github_app",
    "assignee",
    "assigner"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string"
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "event": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "assignee": {
      "$ref": "#/components/schemas/simple-user"
    },
    "assigner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "commit_id": {
      "type": "string",
      "nullable": true
    },
    "commit_url": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/integration"
    }
  },
  "description": "Assigned Issue Event"
}

{
  "type": "object",
  "title": "Authentication Token",
  "required": [
    "token",
    "expires_at"
  ],
  "properties": {
    "token": {
      "type": "string",
      "example": "v1.1f699f1069f60xxx",
      "description": "The token used for authentication"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2016-07-11T22:14:10Z",
      "description": "The time this token expires"
    },
    "permissions": {
      "type": "object",
      "example": {
        "issues": "read",
        "deployments": "write"
      }
    },
    "single_file": {
      "type": "string",
      "example": "config.yaml",
      "nullable": true
    },
    "repositories": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/repository"
      },
      "description": "The repositories this token has access to"
    },
    "repository_selection": {
      "enum": [
        "all",
        "selected"
      ],
      "type": "string",
      "description": "Describe whether all repositories have been selected or there's a selection involved"
    }
  },
  "description": "Authentication Token"
}

{
  "enum": [
    "COLLABORATOR",
    "CONTRIBUTOR",
    "FIRST_TIMER",
    "FIRST_TIME_CONTRIBUTOR",
    "MANNEQUIN",
    "MEMBER",
    "NONE",
    "OWNER"
  ],
  "type": "string",
  "title": "author_association",
  "example": "OWNER",
  "description": "How the author is associated with the repository."
}

{
  "type": "object",
  "title": "Authorization",
  "required": [
    "app",
    "id",
    "note",
    "note_url",
    "scopes",
    "token",
    "hashed_token",
    "token_last_eight",
    "fingerprint",
    "url",
    "created_at",
    "updated_at",
    "expires_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "app": {
      "type": "object",
      "required": [
        "client_id",
        "name",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "format": "uri"
        },
        "name": {
          "type": "string"
        },
        "client_id": {
          "type": "string"
        }
      }
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "note": {
      "type": "string",
      "nullable": true
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "token": {
      "type": "string"
    },
    "scopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "A list of scopes that this authorization is in."
    },
    "note_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "fingerprint": {
      "type": "string",
      "nullable": true
    },
    "hashed_token": {
      "type": "string",
      "nullable": true
    },
    "installation": {
      "$ref": "#/components/schemas/nullable-scoped-installation"
    },
    "token_last_eight": {
      "type": "string",
      "nullable": true
    }
  },
  "description": "The authorization for an OAuth app, GitHub App, or a Personal Access Token."
}

{
  "type": "object",
  "title": "Auto merge",
  "nullable": true,
  "required": [
    "enabled_by",
    "merge_method",
    "commit_title",
    "commit_message"
  ],
  "properties": {
    "enabled_by": {
      "$ref": "#/components/schemas/simple-user"
    },
    "commit_title": {
      "type": "string",
      "description": "Title for the merge commit message."
    },
    "merge_method": {
      "enum": [
        "merge",
        "squash",
        "rebase"
      ],
      "type": "string",
      "description": "The merge method to use."
    },
    "commit_message": {
      "type": "string",
      "description": "Commit message for the merge commit."
    }
  },
  "description": "The status of auto merging a pull request."
}

{
  "type": "object",
  "title": "Autolink reference",
  "required": [
    "id",
    "key_prefix",
    "url_template",
    "is_alphanumeric"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 3
    },
    "key_prefix": {
      "type": "string",
      "example": "TICKET-",
      "description": "The prefix of a key that is linkified."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "url_template": {
      "type": "string",
      "example": "https://example.com/TICKET?query=<num>",
      "description": "A template for the target URL that is generated if a key was found."
    },
    "is_alphanumeric": {
      "type": "boolean",
      "example": true,
      "description": "Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters."
    }
  },
  "description": "An autolink reference."
}

{
  "type": "object",
  "title": "Base Gist",
  "required": [
    "id",
    "node_id",
    "url",
    "forks_url",
    "commits_url",
    "git_pull_url",
    "git_push_url",
    "html_url",
    "comments_url",
    "public",
    "description",
    "comments",
    "user",
    "files",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "files": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "size": {
            "type": "integer"
          },
          "type": {
            "type": "string"
          },
          "raw_url": {
            "type": "string"
          },
          "encoding": {
            "type": "string",
            "default": "utf-8",
            "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported."
          },
          "filename": {
            "type": "string"
          },
          "language": {
            "type": "string"
          }
        }
      }
    },
    "forks": {
      "type": "array",
      "items": {}
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "public": {
      "type": "boolean"
    },
    "history": {
      "type": "array",
      "items": {}
    },
    "node_id": {
      "type": "string"
    },
    "comments": {
      "type": "integer"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "forks_url": {
      "type": "string",
      "format": "uri"
    },
    "truncated": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "commits_url": {
      "type": "string",
      "format": "uri"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "comments_url": {
      "type": "string",
      "format": "uri"
    },
    "git_pull_url": {
      "type": "string",
      "format": "uri"
    },
    "git_push_url": {
      "type": "string",
      "format": "uri"
    },
    "comments_enabled": {
      "type": "boolean"
    }
  },
  "description": "Base Gist",
  "x-github-breaking-changes": [
    {
      "patch": {
        "required": [
          "id",
          "node_id",
          "url",
          "forks_url",
          "commits_url",
          "git_pull_url",
          "git_push_url",
          "html_url",
          "comments_url",
          "public",
          "description",
          "comments",
          "files",
          "created_at",
          "updated_at"
        ],
        "properties": {
          "user": null
        }
      },
      "version": "2026-03-10",
      "changeset": "deprecate_beta_media_type"
    },
    {
      "patch": [
        {
          "op": "remove",
          "path": "/properties/forks"
        },
        {
          "op": "remove",
          "path": "/properties/history"
        }
      ],
      "version": "2026-03-10",
      "changeset": "remove_forks_history_from_base_gist"
    }
  ]
}

{
  "type": "object",
  "title": "Basic Error",
  "properties": {
    "url": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "documentation_url": {
      "type": "string"
    }
  },
  "description": "Basic Error"
}

{
  "type": "object",
  "required": [
    "timePeriod",
    "organization",
    "usageItems"
  ],
  "properties": {
    "user": {
      "type": "string",
      "description": "The name of the user for the usage report."
    },
    "model": {
      "type": "string",
      "description": "The model for the usage report."
    },
    "product": {
      "type": "string",
      "description": "The product for the usage report."
    },
    "timePeriod": {
      "type": "object",
      "required": [
        "year"
      ],
      "properties": {
        "day": {
          "type": "integer",
          "description": "The day for the usage report."
        },
        "year": {
          "type": "integer",
          "description": "The year for the usage report."
        },
        "month": {
          "type": "integer",
          "description": "The month for the usage report."
        }
      }
    },
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product",
          "sku",
          "model",
          "unitType",
          "pricePerUnit",
          "grossQuantity",
          "grossAmount",
          "discountQuantity",
          "discountAmount",
          "netQuantity",
          "netAmount"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "model": {
            "type": "string",
            "description": "Model name."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "netQuantity": {
            "type": "number",
            "description": "Net quantity of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "grossQuantity": {
            "type": "number",
            "description": "Gross quantity of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "discountQuantity": {
            "type": "number",
            "description": "Discount quantity of the usage line item."
          }
        }
      }
    },
    "organization": {
      "type": "string",
      "description": "The unique identifier of the organization."
    }
  }
}

{
  "type": "object",
  "required": [
    "timePeriod",
    "user",
    "usageItems"
  ],
  "properties": {
    "user": {
      "type": "string",
      "description": "The unique identifier of the user."
    },
    "model": {
      "type": "string",
      "description": "The model for the usage report."
    },
    "product": {
      "type": "string",
      "description": "The product for the usage report."
    },
    "timePeriod": {
      "type": "object",
      "required": [
        "year"
      ],
      "properties": {
        "day": {
          "type": "integer",
          "description": "The day for the usage report."
        },
        "year": {
          "type": "integer",
          "description": "The year for the usage report."
        },
        "month": {
          "type": "integer",
          "description": "The month for the usage report."
        }
      }
    },
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product",
          "sku",
          "model",
          "unitType",
          "pricePerUnit",
          "grossQuantity",
          "grossAmount",
          "discountQuantity",
          "discountAmount",
          "netQuantity",
          "netAmount"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "model": {
            "type": "string",
            "description": "Model name."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "netQuantity": {
            "type": "number",
            "description": "Net quantity of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "grossQuantity": {
            "type": "number",
            "description": "Gross quantity of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "discountQuantity": {
            "type": "number",
            "description": "Discount quantity of the usage line item."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date",
          "product",
          "sku",
          "quantity",
          "unitType",
          "pricePerUnit",
          "grossAmount",
          "discountAmount",
          "netAmount",
          "organizationName"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "date": {
            "type": "string",
            "description": "Date of the usage line item."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of the usage line item."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "repositoryName": {
            "type": "string",
            "description": "Name of the repository."
          },
          "organizationName": {
            "type": "string",
            "description": "Name of the organization."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "properties": {
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "date",
          "product",
          "sku",
          "quantity",
          "unitType",
          "pricePerUnit",
          "grossAmount",
          "discountAmount",
          "netAmount"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "date": {
            "type": "string",
            "description": "Date of the usage line item."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "quantity": {
            "type": "integer",
            "description": "Quantity of the usage line item."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "repositoryName": {
            "type": "string",
            "description": "Name of the repository."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "timePeriod",
    "organization",
    "usageItems"
  ],
  "properties": {
    "sku": {
      "type": "string",
      "description": "The SKU for the usage report."
    },
    "product": {
      "type": "string",
      "description": "The product for the usage report."
    },
    "repository": {
      "type": "string",
      "description": "The name of the repository for the usage report."
    },
    "timePeriod": {
      "type": "object",
      "required": [
        "year"
      ],
      "properties": {
        "day": {
          "type": "integer",
          "description": "The day for the usage report."
        },
        "year": {
          "type": "integer",
          "description": "The year for the usage report."
        },
        "month": {
          "type": "integer",
          "description": "The month for the usage report."
        }
      }
    },
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product",
          "sku",
          "unitType",
          "pricePerUnit",
          "grossQuantity",
          "grossAmount",
          "discountQuantity",
          "discountAmount",
          "netQuantity",
          "netAmount"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "netQuantity": {
            "type": "number",
            "description": "Net quantity of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "grossQuantity": {
            "type": "number",
            "description": "Gross quantity of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "discountQuantity": {
            "type": "number",
            "description": "Discount quantity of the usage line item."
          }
        }
      }
    },
    "organization": {
      "type": "string",
      "description": "The unique identifier of the organization."
    }
  }
}

{
  "type": "object",
  "required": [
    "timePeriod",
    "user",
    "usageItems"
  ],
  "properties": {
    "sku": {
      "type": "string",
      "description": "The SKU for the usage report."
    },
    "user": {
      "type": "string",
      "description": "The unique identifier of the user."
    },
    "product": {
      "type": "string",
      "description": "The product for the usage report."
    },
    "repository": {
      "type": "string",
      "description": "The name of the repository for the usage report."
    },
    "timePeriod": {
      "type": "object",
      "required": [
        "year"
      ],
      "properties": {
        "day": {
          "type": "integer",
          "description": "The day for the usage report."
        },
        "year": {
          "type": "integer",
          "description": "The year for the usage report."
        },
        "month": {
          "type": "integer",
          "description": "The month for the usage report."
        }
      }
    },
    "usageItems": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "product",
          "sku",
          "unitType",
          "pricePerUnit",
          "grossQuantity",
          "grossAmount",
          "discountQuantity",
          "discountAmount",
          "netQuantity",
          "netAmount"
        ],
        "properties": {
          "sku": {
            "type": "string",
            "description": "SKU name."
          },
          "product": {
            "type": "string",
            "description": "Product name."
          },
          "unitType": {
            "type": "string",
            "description": "Unit type of the usage line item."
          },
          "netAmount": {
            "type": "number",
            "description": "Net amount of the usage line item."
          },
          "grossAmount": {
            "type": "number",
            "description": "Gross amount of the usage line item."
          },
          "netQuantity": {
            "type": "number",
            "description": "Net quantity of the usage line item."
          },
          "pricePerUnit": {
            "type": "number",
            "description": "Price per unit of the usage line item."
          },
          "grossQuantity": {
            "type": "number",
            "description": "Gross quantity of the usage line item."
          },
          "discountAmount": {
            "type": "number",
            "description": "Discount amount of the usage line item."
          },
          "discountQuantity": {
            "type": "number",
            "description": "Discount quantity of the usage line item."
          }
        }
      }
    }
  }
}

{
  "type": "object",
  "title": "Blob",
  "required": [
    "sha",
    "url",
    "node_id",
    "size",
    "content",
    "encoding"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "size": {
      "type": "integer",
      "nullable": true
    },
    "content": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "encoding": {
      "type": "string"
    },
    "highlighted_content": {
      "type": "string"
    }
  },
  "description": "Blob"
}

{
  "type": "object",
  "title": "Branch Protection",
  "properties": {
    "url": {
      "type": "string"
    },
    "name": {
      "type": "string",
      "example": "\"branch/with/protection\""
    },
    "enabled": {
      "type": "boolean"
    },
    "lock_branch": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": false
        }
      },
      "description": "Whether to set the branch as read-only. If this is true, users will not be able to push to the branch."
    },
    "restrictions": {
      "$ref": "#/components/schemas/branch-restriction-policy"
    },
    "enforce_admins": {
      "$ref": "#/components/schemas/protected-branch-admin-enforced"
    },
    "protection_url": {
      "type": "string",
      "example": "\"https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection\""
    },
    "allow_deletions": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "block_creations": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "allow_force_pushes": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "allow_fork_syncing": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "default": false
        }
      },
      "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing."
    },
    "required_signatures": {
      "type": "object",
      "required": [
        "url",
        "enabled"
      ],
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures"
        },
        "enabled": {
          "type": "boolean",
          "example": true
        }
      }
    },
    "required_status_checks": {
      "$ref": "#/components/schemas/protected-branch-required-status-check"
    },
    "required_linear_history": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "required_pull_request_reviews": {
      "$ref": "#/components/schemas/protected-branch-pull-request-review"
    },
    "required_conversation_resolution": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    }
  },
  "description": "Branch Protection"
}

{
  "type": "object",
  "title": "Branch Restriction Policy",
  "required": [
    "url",
    "users_url",
    "teams_url",
    "apps_url",
    "users",
    "teams",
    "apps"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri"
    },
    "apps": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": "string"
          },
          "owner": {
            "type": "object",
            "properties": {
              "id": {
                "type": "integer"
              },
              "url": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "example": "\"Organization\""
              },
              "login": {
                "type": "string"
              },
              "node_id": {
                "type": "string"
              },
              "html_url": {
                "type": "string",
                "example": "\"https://github.com/testorg-ea8ec76d71c3af4b\""
              },
              "gists_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}\""
              },
              "hooks_url": {
                "type": "string"
              },
              "repos_url": {
                "type": "string"
              },
              "avatar_url": {
                "type": "string"
              },
              "events_url": {
                "type": "string"
              },
              "issues_url": {
                "type": "string"
              },
              "site_admin": {
                "type": "boolean",
                "example": false
              },
              "description": {
                "type": "string"
              },
              "gravatar_id": {
                "type": "string",
                "example": "\"\""
              },
              "members_url": {
                "type": "string"
              },
              "starred_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}\""
              },
              "followers_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers\""
              },
              "following_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}\""
              },
              "user_view_type": {
                "type": "string",
                "example": "public"
              },
              "organizations_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs\""
              },
              "subscriptions_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions\""
              },
              "public_members_url": {
                "type": "string"
              },
              "received_events_url": {
                "type": "string",
                "example": "\"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events\""
              }
            }
          },
          "events": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "node_id": {
            "type": "string"
          },
          "html_url": {
            "type": "string"
          },
          "client_id": {
            "type": "string"
          },
          "created_at": {
            "type": "string"
          },
          "updated_at": {
            "type": "string"
          },
          "description": {
            "type": "string"
          },
          "permissions": {
            "type": "object",
            "properties": {
              "issues": {
                "type": "string"
              },
              "contents": {
                "type": "string"
              },
              "metadata": {
                "type": "string"
              },
              "single_file": {
                "type": "string"
              }
            }
          },
          "external_url": {
            "type": "string"
          }
        }
      }
    },
    "teams": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/team"
      }
    },
    "users": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "url": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "login": {
            "type": "string"
          },
          "node_id": {
            "type": "string"
          },
          "html_url": {
            "type": "string"
          },
          "gists_url": {
            "type": "string"
          },
          "repos_url": {
            "type": "string"
          },
          "avatar_url": {
            "type": "string"
          },
          "events_url": {
            "type": "string"
          },
          "site_admin": {
            "type": "boolean"
          },
          "gravatar_id": {
            "type": "string"
          },
          "starred_url": {
            "type": "string"
          },
          "followers_url": {
            "type": "string"
          },
          "following_url": {
            "type": "string"
          },
          "user_view_type": {
            "type": "string"
          },
          "organizations_url": {
            "type": "string"
          },
          "subscriptions_url": {
            "type": "string"
          },
          "received_events_url": {
            "type": "string"
          }
        }
      }
    },
    "apps_url": {
      "type": "string",
      "format": "uri"
    },
    "teams_url": {
      "type": "string",
      "format": "uri"
    },
    "users_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Branch Restriction Policy"
}

{
  "type": "object",
  "title": "Branch Short",
  "required": [
    "name",
    "commit",
    "protected"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "commit": {
      "type": "object",
      "required": [
        "sha",
        "url"
      ],
      "properties": {
        "sha": {
          "type": "string"
        },
        "url": {
          "type": "string"
        }
      }
    },
    "protected": {
      "type": "boolean"
    }
  },
  "description": "Branch Short"
}

{
  "type": "object",
  "title": "Branch With Protection",
  "required": [
    "name",
    "commit",
    "_links",
    "protection",
    "protected",
    "protection_url"
  ],
  "properties": {
    "name": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "required": [
        "html",
        "self"
      ],
      "properties": {
        "html": {
          "type": "string"
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "commit": {
      "$ref": "#/components/schemas/commit"
    },
    "pattern": {
      "type": "string",
      "example": "\"mas*\""
    },
    "protected": {
      "type": "boolean"
    },
    "protection": {
      "$ref": "#/components/schemas/branch-protection"
    },
    "protection_url": {
      "type": "string",
      "format": "uri"
    },
    "required_approving_review_count": {
      "type": "integer",
      "example": 1
    }
  },
  "description": "Branch With Protection"
}

{
  "type": "object",
  "required": [
    "id",
    "budget_type",
    "budget_product_sku",
    "budget_scope",
    "budget_amount",
    "prevent_further_usage",
    "budget_alerting"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "2066deda-923f-43f9-88d2-62395a28c0cdd",
      "description": "The unique identifier for the budget"
    },
    "budget_type": {
      "oneOf": [
        {
          "enum": [
            "SkuPricing"
          ],
          "type": "string"
        },
        {
          "enum": [
            "ProductPricing"
          ],
          "type": "string"
        }
      ],
      "example": "SkuPricing",
      "description": "The type of pricing for the budget"
    },
    "budget_scope": {
      "type": "string",
      "example": "enterprise",
      "description": "The scope of the budget (enterprise, organization, repository, cost center)"
    },
    "budget_amount": {
      "type": "integer",
      "description": "The budget amount limit in whole dollars. For license-based products, this represents the number of licenses."
    },
    "budget_alerting": {
      "type": "object",
      "required": [
        "will_alert",
        "alert_recipients"
      ],
      "properties": {
        "will_alert": {
          "type": "boolean",
          "example": true,
          "description": "Whether alerts are enabled for this budget"
        },
        "alert_recipients": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "example": [
            "mona",
            "lisa"
          ],
          "description": "Array of user login names who will receive alerts"
        }
      }
    },
    "budget_entity_name": {
      "type": "string",
      "example": "octocat/hello-world",
      "description": "The name of the entity for the budget (enterprise does not require a name)."
    },
    "budget_product_sku": {
      "type": "string",
      "description": "A single product or sku to apply the budget to."
    },
    "prevent_further_usage": {
      "type": "boolean",
      "example": true,
      "description": "The type of limit enforcement for the budget"
    }
  }
}

{
  "enum": [
    "code_scanning",
    "secret_scanning"
  ],
  "type": "string",
  "title": "Campaign alert type",
  "description": "Indicates the alert type of a campaign"
}

{
  "enum": [
    "open",
    "closed"
  ],
  "type": "string",
  "title": "Campaign state",
  "description": "Indicates whether a campaign is open or closed"
}

{
  "type": "object",
  "title": "Campaign summary",
  "required": [
    "number",
    "created_at",
    "updated_at",
    "description",
    "managers",
    "ends_at",
    "state",
    "contact_link"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "The campaign name"
    },
    "state": {
      "$ref": "#/components/schemas/campaign-state"
    },
    "number": {
      "type": "integer",
      "description": "The number of the newly created campaign"
    },
    "ends_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the campaign has ended, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "managers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      },
      "description": "The campaign managers"
    },
    "closed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The date and time the campaign was closed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the campaign is still open."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the campaign was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the campaign was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "alert_stats": {
      "type": "object",
      "required": [
        "open_count",
        "closed_count",
        "in_progress_count"
      ],
      "properties": {
        "open_count": {
          "type": "integer",
          "description": "The number of open alerts"
        },
        "closed_count": {
          "type": "integer",
          "description": "The number of closed alerts"
        },
        "in_progress_count": {
          "type": "integer",
          "description": "The number of in-progress alerts"
        }
      },
      "additionalProperties": false
    },
    "description": {
      "type": "string",
      "description": "The campaign description"
    },
    "contact_link": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "The contact link of the campaign."
    },
    "published_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time the campaign was published, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "team_managers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/team"
      },
      "description": "The campaign team managers"
    }
  },
  "description": "The campaign metadata and alert stats."
}

{
  "type": "object",
  "title": "Check Annotation",
  "required": [
    "path",
    "blob_href",
    "start_line",
    "end_line",
    "start_column",
    "end_column",
    "annotation_level",
    "title",
    "message",
    "raw_details"
  ],
  "properties": {
    "path": {
      "type": "string",
      "example": "README.md"
    },
    "title": {
      "type": "string",
      "example": "Spell Checker",
      "nullable": true
    },
    "message": {
      "type": "string",
      "example": "Check your spelling for 'banaas'.",
      "nullable": true
    },
    "end_line": {
      "type": "integer",
      "example": 2
    },
    "blob_href": {
      "type": "string"
    },
    "end_column": {
      "type": "integer",
      "example": 10,
      "nullable": true
    },
    "start_line": {
      "type": "integer",
      "example": 2
    },
    "raw_details": {
      "type": "string",
      "example": "Do you mean 'bananas' or 'banana'?",
      "nullable": true
    },
    "start_column": {
      "type": "integer",
      "example": 5,
      "nullable": true
    },
    "annotation_level": {
      "type": "string",
      "example": "warning",
      "nullable": true
    }
  },
  "description": "Check Annotation"
}

{
  "type": "object",
  "title": "Check Dependabot security updates",
  "required": [
    "enabled",
    "paused"
  ],
  "properties": {
    "paused": {
      "type": "boolean",
      "example": false,
      "description": "Whether Dependabot security updates are paused for the repository."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether Dependabot security updates are enabled for the repository."
    }
  },
  "description": "Check Dependabot security updates"
}

{
  "type": "object",
  "title": "Check immutable releases",
  "required": [
    "enabled",
    "enforced_by_owner"
  ],
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether immutable releases are enabled for the repository."
    },
    "enforced_by_owner": {
      "type": "boolean",
      "example": false,
      "description": "Whether immutable releases are enforced by the repository owner."
    }
  },
  "description": "Check immutable releases"
}

{
  "type": "object",
  "title": "CheckRun",
  "required": [
    "id",
    "node_id",
    "head_sha",
    "name",
    "url",
    "html_url",
    "details_url",
    "status",
    "conclusion",
    "started_at",
    "completed_at",
    "external_id",
    "check_suite",
    "output",
    "app",
    "pull_requests"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 21,
      "description": "The id of the check."
    },
    "app": {
      "$ref": "#/components/schemas/nullable-integration"
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
    },
    "name": {
      "type": "string",
      "example": "test-coverage",
      "description": "The name of the check."
    },
    "output": {
      "type": "object",
      "required": [
        "title",
        "summary",
        "text",
        "annotations_count",
        "annotations_url"
      ],
      "properties": {
        "text": {
          "type": "string",
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "summary": {
          "type": "string",
          "nullable": true
        },
        "annotations_url": {
          "type": "string",
          "format": "uri"
        },
        "annotations_count": {
          "type": "integer"
        }
      }
    },
    "status": {
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "waiting",
        "requested",
        "pending"
      ],
      "type": "string",
      "example": "queued",
      "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs."
    },
    "node_id": {
      "type": "string",
      "example": "MDg6Q2hlY2tSdW40"
    },
    "head_sha": {
      "type": "string",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "description": "The SHA of the commit that is being checked."
    },
    "html_url": {
      "type": "string",
      "example": "https://github.com/github/hello-world/runs/4",
      "nullable": true
    },
    "conclusion": {
      "enum": [
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required"
      ],
      "type": "string",
      "example": "neutral",
      "nullable": true
    },
    "deployment": {
      "$ref": "#/components/schemas/deployment-simple"
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z",
      "nullable": true
    },
    "check_suite": {
      "type": "object",
      "nullable": true,
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        }
      }
    },
    "details_url": {
      "type": "string",
      "example": "https://example.com",
      "nullable": true
    },
    "external_id": {
      "type": "string",
      "example": "42",
      "nullable": true
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z",
      "nullable": true
    },
    "pull_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      },
      "description": "Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check."
    }
  },
  "description": "A check performed on the code of a given code change"
}

{
  "type": "object",
  "title": "CheckRun",
  "required": [
    "id",
    "node_id",
    "head_sha",
    "name",
    "url",
    "html_url",
    "details_url",
    "status",
    "conclusion",
    "started_at",
    "completed_at",
    "external_id",
    "check_suite",
    "output",
    "app",
    "pull_requests"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 21,
      "description": "The id of the check."
    },
    "app": {
      "$ref": "#/components/schemas/integration"
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/check-runs/4"
    },
    "name": {
      "type": "string",
      "example": "test-coverage",
      "description": "The name of the check."
    },
    "output": {
      "type": "object",
      "required": [
        "title",
        "summary",
        "text",
        "annotations_count",
        "annotations_url"
      ],
      "properties": {
        "text": {
          "type": "string",
          "nullable": true
        },
        "title": {
          "type": "string",
          "nullable": true
        },
        "summary": {
          "type": "string",
          "nullable": true
        },
        "annotations_url": {
          "type": "string",
          "format": "uri"
        },
        "annotations_count": {
          "type": "integer"
        }
      }
    },
    "status": {
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "pending"
      ],
      "type": "string",
      "example": "queued",
      "description": "The phase of the lifecycle that the check is currently in."
    },
    "node_id": {
      "type": "string",
      "example": "MDg6Q2hlY2tSdW40"
    },
    "head_sha": {
      "type": "string",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "description": "The SHA of the commit that is being checked."
    },
    "html_url": {
      "type": "string",
      "example": "https://github.com/github/hello-world/runs/4"
    },
    "conclusion": {
      "enum": [
        "waiting",
        "pending",
        "startup_failure",
        "stale",
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required"
      ],
      "type": "string",
      "example": "neutral",
      "nullable": true
    },
    "deployment": {
      "$ref": "#/components/schemas/deployment-simple"
    },
    "started_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z"
    },
    "check_suite": {
      "$ref": "#/components/schemas/simple-check-suite"
    },
    "details_url": {
      "type": "string",
      "example": "https://example.com"
    },
    "external_id": {
      "type": "string",
      "example": "42"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-05-04T01:14:52Z",
      "nullable": true
    },
    "pull_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      }
    }
  },
  "description": "A check performed on the code of a given code change"
}

{
  "type": "object",
  "title": "CheckSuite",
  "required": [
    "id",
    "node_id",
    "head_branch",
    "status",
    "conclusion",
    "head_sha",
    "url",
    "before",
    "after",
    "created_at",
    "updated_at",
    "app",
    "head_commit",
    "repository",
    "latest_check_runs_count",
    "check_runs_url",
    "pull_requests"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 5
    },
    "app": {
      "$ref": "#/components/schemas/nullable-integration"
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/repos/github/hello-world/check-suites/5",
      "nullable": true
    },
    "after": {
      "type": "string",
      "example": "d6fde92930d4715a2b49857d24b940956b26d2d3",
      "nullable": true
    },
    "before": {
      "type": "string",
      "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912",
      "nullable": true
    },
    "status": {
      "enum": [
        "queued",
        "in_progress",
        "completed",
        "waiting",
        "requested",
        "pending"
      ],
      "type": "string",
      "example": "completed",
      "nullable": true,
      "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites."
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkNoZWNrU3VpdGU1"
    },
    "head_sha": {
      "type": "string",
      "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d",
      "description": "The SHA of the head commit that is being checked."
    },
    "conclusion": {
      "enum": [
        "success",
        "failure",
        "neutral",
        "cancelled",
        "skipped",
        "timed_out",
        "action_required",
        "startup_failure",
        "stale",
        null
      ],
      "type": "string",
      "example": "neutral",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "head_branch": {
      "type": "string",
      "example": "master",
      "nullable": true
    },
    "head_commit": {
      "$ref": "#/components/schemas/simple-commit"
    },
    "pull_requests": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pull-request-minimal"
      },
      "nullable": true
    },
    "rerequestable": {
      "type": "boolean"
    },
    "check_runs_url": {
      "type": "string"
    },
    "runs_rerequestable": {
      "type": "boolean"
    },
    "latest_check_runs_count": {
      "type": "integer"
    }
  },
  "description": "A suite of checks performed on the code of a given code change"
}

{
  "type": "object",
  "title": "Check Suite Preference",
  "required": [
    "preferences",
    "repository"
  ],
  "properties": {
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "preferences": {
      "type": "object",
      "properties": {
        "auto_trigger_checks": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "app_id",
              "setting"
            ],
            "properties": {
              "app_id": {
                "type": "integer"
              },
              "setting": {
                "type": "boolean"
              }
            }
          }
        }
      }
    }
  },
  "description": "Check suite configuration preferences for a repository."
}

{
  "type": "object",
  "title": "Classroom",
  "required": [
    "id",
    "name",
    "archived",
    "organization",
    "url"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 42,
      "description": "Unique identifier of the classroom."
    },
    "url": {
      "type": "string",
      "example": "https://classroom.github.com/classrooms/1-programming-elixir",
      "description": "The URL of the classroom on GitHub Classroom."
    },
    "name": {
      "type": "string",
      "example": "Programming Elixir",
      "description": "The name of the classroom."
    },
    "archived": {
      "type": "boolean",
      "example": false,
      "description": "Whether classroom is archived."
    },
    "organization": {
      "$ref": "#/components/schemas/simple-classroom-organization"
    }
  },
  "description": "A GitHub Classroom classroom"
}

{
  "type": "object",
  "title": "Classroom Accepted Assignment",
  "required": [
    "id",
    "submitted",
    "passing",
    "commit_count",
    "grade",
    "students",
    "repository",
    "assignment"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 42,
      "description": "Unique identifier of the repository."
    },
    "grade": {
      "type": "string",
      "example": "10/10",
      "description": "Most recent grade."
    },
    "passing": {
      "type": "boolean",
      "example": true,
      "description": "Whether a submission passed."
    },
    "students": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-classroom-user"
      }
    },
    "submitted": {
      "type": "boolean",
      "example": true,
      "description": "Whether an accepted assignment has been submitted."
    },
    "assignment": {
      "$ref": "#/components/schemas/simple-classroom-assignment"
    },
    "repository": {
      "$ref": "#/components/schemas/simple-classroom-repository"
    },
    "commit_count": {
      "type": "integer",
      "example": 5,
      "description": "Count of student commits."
    }
  },
  "description": "A GitHub Classroom accepted assignment"
}

{
  "type": "object",
  "title": "Classroom Assignment",
  "required": [
    "id",
    "public_repo",
    "title",
    "type",
    "invite_link",
    "invitations_enabled",
    "slug",
    "students_are_repo_admins",
    "feedback_pull_requests_enabled",
    "max_teams",
    "max_members",
    "editor",
    "accepted",
    "submitted",
    "passing",
    "language",
    "deadline",
    "starter_code_repository",
    "classroom"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 42,
      "description": "Unique identifier of the repository."
    },
    "slug": {
      "type": "string",
      "example": "intro-to-binaries",
      "description": "Sluggified name of the assignment."
    },
    "type": {
      "enum": [
        "individual",
        "group"
      ],
      "type": "string",
      "example": "individual",
      "description": "Whether it's a group assignment or individual assignment."
    },
    "title": {
      "type": "string",
      "example": "Intro to Binaries",
      "description": "Assignment title."
    },
    "editor": {
      "type": "string",
      "example": "codespaces",
      "description": "The selected editor for the assignment."
    },
    "passing": {
      "type": "integer",
      "example": 10,
      "description": "The number of students that have passed the assignment."
    },
    "accepted": {
      "type": "integer",
      "example": 25,
      "description": "The number of students that have accepted the assignment."
    },
    "deadline": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:06:43Z",
      "nullable": true,
      "description": "The time at which the assignment is due."
    },
    "language": {
      "type": "string",
      "example": "elixir",
      "description": "The programming language used in the assignment."
    },
    "classroom": {
      "$ref": "#/components/schemas/classroom"
    },
    "max_teams": {
      "type": "integer",
      "example": 0,
      "nullable": true,
      "description": "The maximum allowable teams for the assignment."
    },
    "submitted": {
      "type": "integer",
      "example": 10,
      "description": "The number of students that have submitted the assignment."
    },
    "invite_link": {
      "type": "string",
      "example": "https://classroom.github.com/a/Lx7jiUgx",
      "description": "The link that a student can use to accept the assignment."
    },
    "max_members": {
      "type": "integer",
      "example": 0,
      "nullable": true,
      "description": "The maximum allowable members per team."
    },
    "public_repo": {
      "type": "boolean",
      "example": true,
      "description": "Whether an accepted assignment creates a public repository."
    },
    "invitations_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment."
    },
    "starter_code_repository": {
      "$ref": "#/components/schemas/simple-classroom-repository"
    },
    "students_are_repo_admins": {
      "type": "boolean",
      "example": true,
      "description": "Whether students are admins on created repository when a student accepts the assignment."
    },
    "feedback_pull_requests_enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether feedback pull request will be created when a student accepts the assignment."
    }
  },
  "description": "A GitHub Classroom assignment"
}

{
  "type": "object",
  "title": "Classroom Assignment Grade",
  "required": [
    "assignment_name",
    "assignment_url",
    "starter_code_url",
    "github_username",
    "roster_identifier",
    "student_repository_name",
    "student_repository_url",
    "submission_timestamp",
    "points_awarded",
    "points_available"
  ],
  "properties": {
    "group_name": {
      "type": "string",
      "description": "If a group assignment, name of the group the student is in"
    },
    "assignment_url": {
      "type": "string",
      "description": "URL of the assignment"
    },
    "points_awarded": {
      "type": "integer",
      "description": "Number of points awarded to the student"
    },
    "assignment_name": {
      "type": "string",
      "description": "Name of the assignment"
    },
    "github_username": {
      "type": "string",
      "description": "GitHub username of the student"
    },
    "points_available": {
      "type": "integer",
      "description": "Number of points available for the assignment"
    },
    "starter_code_url": {
      "type": "string",
      "description": "URL of the starter code for the assignment"
    },
    "roster_identifier": {
      "type": "string",
      "description": "Roster identifier of the student"
    },
    "submission_timestamp": {
      "type": "string",
      "description": "Timestamp of the student's assignment submission"
    },
    "student_repository_url": {
      "type": "string",
      "description": "URL of the student's assignment repository"
    },
    "student_repository_name": {
      "type": "string",
      "description": "Name of the student's assignment repository"
    }
  },
  "description": "Grade for a student or groups GitHub Classroom assignment"
}

{
  "type": "object",
  "title": "Clone Traffic",
  "required": [
    "uniques",
    "count",
    "clones"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "example": 173
    },
    "clones": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/traffic"
      }
    },
    "uniques": {
      "type": "integer",
      "example": 128
    }
  },
  "description": "Clone Traffic"
}

{
  "type": "array",
  "items": {
    "type": "integer"
  },
  "title": "Code Frequency Stat",
  "description": "Code Frequency Stat"
}

{
  "type": "object",
  "title": "Code Of Conduct",
  "required": [
    "url",
    "html_url",
    "key",
    "name"
  ],
  "properties": {
    "key": {
      "type": "string",
      "example": "contributor_covenant"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/codes_of_conduct/contributor_covenant"
    },
    "body": {
      "type": "string",
      "example": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n                  to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n                  posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
    },
    "name": {
      "type": "string",
      "example": "Contributor Covenant"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "description": "Code Of Conduct"
}

{
  "type": "object",
  "title": "Code Of Conduct Simple",
  "required": [
    "url",
    "key",
    "name",
    "html_url"
  ],
  "properties": {
    "key": {
      "type": "string",
      "example": "citizen_code_of_conduct"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/github/docs/community/code_of_conduct"
    },
    "name": {
      "type": "string",
      "example": "Citizen Code of Conduct"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md",
      "nullable": true
    }
  },
  "description": "Code of Conduct Simple"
}

{
  "type": "object",
  "required": [
    "number",
    "created_at",
    "url",
    "html_url",
    "instances_url",
    "state",
    "dismissed_by",
    "dismissed_at",
    "dismissed_reason",
    "rule",
    "tool",
    "most_recent_instance"
  ],
  "properties": {
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "rule": {
      "$ref": "#/components/schemas/code-scanning-alert-rule"
    },
    "tool": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-state"
    },
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "assignees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      }
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "instances_url": {
      "$ref": "#/components/schemas/alert-instances-url"
    },
    "dismissed_reason": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
    },
    "dismissed_comment": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
    },
    "most_recent_instance": {
      "$ref": "#/components/schemas/code-scanning-alert-instance"
    },
    "dismissal_approved_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    }
  }
}

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "description": "The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert."
}

{
  "enum": [
    "source",
    "generated",
    "test",
    "library"
  ],
  "type": "string",
  "nullable": true,
  "description": "A classification of the file. For example to identify it as generated."
}

{
  "type": "boolean",
  "description": "If `true`, attempt to create an alert dismissal request."
}

{
  "type": "string",
  "nullable": true,
  "maxLength": 280,
  "description": "The dismissal comment associated with the dismissal of the alert."
}

{
  "enum": [
    "false positive",
    "won't fix",
    "used in tests"
  ],
  "type": "string",
  "nullable": true,
  "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert."
}

{
  "type": "string",
  "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
}

{
  "type": "object",
  "properties": {
    "ref": {
      "$ref": "#/components/schemas/code-scanning-ref"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-state"
    },
    "message": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "markdown": {
          "type": "string",
          "description": "The message text as GitHub-flavored Markdown, with placeholder links for related locations replaced by links to the relevant code. Only populated when related locations are available for the alert instance."
        }
      }
    },
    "category": {
      "$ref": "#/components/schemas/code-scanning-analysis-category"
    },
    "html_url": {
      "type": "string"
    },
    "location": {
      "$ref": "#/components/schemas/code-scanning-alert-location"
    },
    "commit_sha": {
      "type": "string"
    },
    "environment": {
      "$ref": "#/components/schemas/code-scanning-alert-environment"
    },
    "analysis_key": {
      "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
    },
    "classifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/code-scanning-alert-classification"
      },
      "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file."
    }
  }
}

{
  "type": "object",
  "properties": {
    "ref": {
      "$ref": "#/components/schemas/code-scanning-ref"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-instance-state"
    },
    "message": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        }
      }
    },
    "category": {
      "$ref": "#/components/schemas/code-scanning-analysis-category"
    },
    "html_url": {
      "type": "string"
    },
    "location": {
      "$ref": "#/components/schemas/code-scanning-alert-location"
    },
    "commit_sha": {
      "type": "string"
    },
    "environment": {
      "$ref": "#/components/schemas/code-scanning-alert-environment"
    },
    "analysis_key": {
      "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
    },
    "classifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/code-scanning-alert-classification"
      },
      "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file."
    }
  }
}

{
  "enum": [
    "open",
    "fixed"
  ],
  "type": "string",
  "nullable": true,
  "description": "State of a code scanning alert instance."
}

{
  "type": "object",
  "required": [
    "number",
    "created_at",
    "url",
    "html_url",
    "instances_url",
    "state",
    "dismissed_by",
    "dismissed_at",
    "dismissed_reason",
    "rule",
    "tool",
    "most_recent_instance"
  ],
  "properties": {
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "rule": {
      "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
    },
    "tool": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-state"
    },
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "assignees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      }
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "instances_url": {
      "$ref": "#/components/schemas/alert-instances-url"
    },
    "dismissed_reason": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
    },
    "dismissed_comment": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
    },
    "most_recent_instance": {
      "$ref": "#/components/schemas/code-scanning-alert-instance"
    },
    "dismissal_approved_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    }
  }
}

{
  "type": "object",
  "properties": {
    "path": {
      "type": "string"
    },
    "end_line": {
      "type": "integer"
    },
    "end_column": {
      "type": "integer"
    },
    "start_line": {
      "type": "integer"
    },
    "start_column": {
      "type": "integer"
    }
  },
  "description": "Describe a region within a file for the alert."
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "description": "A unique identifier for the rule used to detect the alert."
    },
    "help": {
      "type": "string",
      "nullable": true,
      "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
    },
    "name": {
      "type": "string",
      "description": "The name of the rule used to detect the alert."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "A set of tags applicable for the rule."
    },
    "help_uri": {
      "type": "string",
      "nullable": true,
      "description": "A link to the documentation for the rule used to detect the alert."
    },
    "severity": {
      "enum": [
        "none",
        "note",
        "warning",
        "error"
      ],
      "type": "string",
      "nullable": true,
      "description": "The severity of the alert."
    },
    "description": {
      "type": "string",
      "description": "A short description of the rule used to detect the alert."
    },
    "full_description": {
      "type": "string",
      "description": "A description of the rule used to detect the alert."
    },
    "security_severity_level": {
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ],
      "type": "string",
      "nullable": true,
      "description": "The security severity of the alert."
    }
  }
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "description": "A unique identifier for the rule used to detect the alert."
    },
    "help": {
      "type": "string",
      "nullable": true,
      "description": "Detailed documentation for the rule as GitHub Flavored Markdown."
    },
    "name": {
      "type": "string",
      "description": "The name of the rule used to detect the alert."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "A set of tags applicable for the rule."
    },
    "help_uri": {
      "type": "string",
      "nullable": true,
      "description": "A link to the documentation for the rule used to detect the alert."
    },
    "severity": {
      "enum": [
        "none",
        "note",
        "warning",
        "error"
      ],
      "type": "string",
      "nullable": true,
      "description": "The severity of the alert."
    },
    "description": {
      "type": "string",
      "description": "A short description of the rule used to detect the alert."
    },
    "full_description": {
      "type": "string",
      "description": "A description of the rule used to detect the alert."
    },
    "security_severity_level": {
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ],
      "type": "string",
      "nullable": true,
      "description": "The security severity of the alert."
    }
  }
}

{
  "enum": [
    "open",
    "dismissed"
  ],
  "type": "string",
  "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`."
}

{
  "enum": [
    "critical",
    "high",
    "medium",
    "low",
    "warning",
    "note",
    "error"
  ],
  "type": "string",
  "description": "Severity of a code scanning alert."
}

{
  "enum": [
    "open",
    "dismissed",
    "fixed"
  ],
  "type": "string",
  "nullable": true,
  "description": "State of a code scanning alert."
}

{
  "enum": [
    "open",
    "closed",
    "dismissed",
    "fixed"
  ],
  "type": "string",
  "description": "State of a code scanning alert."
}

{
  "type": "object",
  "required": [
    "ref",
    "commit_sha",
    "analysis_key",
    "environment",
    "error",
    "created_at",
    "results_count",
    "rules_count",
    "id",
    "url",
    "sarif_id",
    "tool",
    "deletable",
    "warning"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Unique identifier for this analysis."
    },
    "ref": {
      "$ref": "#/components/schemas/code-scanning-ref"
    },
    "url": {
      "$ref": "#/components/schemas/code-scanning-analysis-url"
    },
    "tool": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool"
    },
    "error": {
      "type": "string",
      "example": "error reading field xyz"
    },
    "warning": {
      "type": "string",
      "example": "123 results were ignored",
      "description": "Warning generated when processing the analysis"
    },
    "category": {
      "$ref": "#/components/schemas/code-scanning-analysis-category"
    },
    "sarif_id": {
      "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
    },
    "deletable": {
      "type": "boolean"
    },
    "commit_sha": {
      "$ref": "#/components/schemas/code-scanning-analysis-commit-sha"
    },
    "created_at": {
      "$ref": "#/components/schemas/code-scanning-analysis-created-at"
    },
    "environment": {
      "$ref": "#/components/schemas/code-scanning-analysis-environment"
    },
    "rules_count": {
      "type": "integer",
      "description": "The total number of rules used in the analysis."
    },
    "analysis_key": {
      "$ref": "#/components/schemas/code-scanning-analysis-analysis-key"
    },
    "results_count": {
      "type": "integer",
      "description": "The total number of results in the analysis."
    }
  }
}

{
  "type": "string",
  "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
}

{
  "type": "string",
  "description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
}

{
  "type": "string",
  "pattern": "^[0-9a-fA-F]+$",
  "maxLength": 40,
  "minLength": 40,
  "description": "The SHA of the commit to which the analysis you are uploading relates."
}

{
  "type": "string",
  "format": "date-time",
  "readOnly": true,
  "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "type": "object",
  "title": "Analysis deletion",
  "required": [
    "next_analysis_url",
    "confirm_delete_url"
  ],
  "properties": {
    "next_analysis_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "description": "Next deletable analysis in chain, without last analysis deletion confirmation"
    },
    "confirm_delete_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "description": "Next deletable analysis in chain, with last analysis deletion confirmation"
    }
  },
  "description": "Successful deletion of a code scanning analysis"
}

{
  "type": "string",
  "description": "Identifies the variable values associated with the environment in which this analysis was performed."
}

{
  "type": "string",
  "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\""
}

{
  "type": "string",
  "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53",
  "description": "An identifier for the upload."
}

{
  "type": "object",
  "properties": {
    "guid": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool-guid"
    },
    "name": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool-name"
    },
    "version": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool-version"
    }
  }
}

{
  "type": "string",
  "nullable": true,
  "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
}

{
  "type": "string",
  "description": "The name of the tool used to generate the code scanning analysis."
}

{
  "type": "string",
  "nullable": true,
  "description": "The version of the tool used to generate the code scanning analysis."
}

{
  "type": "string",
  "format": "uri",
  "readOnly": true,
  "description": "The REST API URL of the analysis resource."
}

{
  "type": "object",
  "required": [
    "status",
    "description",
    "started_at"
  ],
  "properties": {
    "status": {
      "$ref": "#/components/schemas/code-scanning-autofix-status"
    },
    "started_at": {
      "$ref": "#/components/schemas/code-scanning-autofix-started-at"
    },
    "description": {
      "$ref": "#/components/schemas/code-scanning-autofix-description"
    }
  }
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "message": {
      "type": "string",
      "description": "Commit message to be used."
    },
    "target_ref": {
      "type": "string",
      "description": "The Git reference of target branch for the commit. Branch needs to already exist.  For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation."
    }
  },
  "description": "Commit an autofix for a code scanning alert"
}

{
  "type": "object",
  "properties": {
    "sha": {
      "type": "string",
      "description": "SHA of commit with autofix."
    },
    "target_ref": {
      "type": "string",
      "description": "The Git reference of target branch for the commit. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation."
    }
  }
}

{
  "type": "string",
  "nullable": true,
  "description": "The description of an autofix."
}

{
  "type": "string",
  "format": "date-time",
  "readOnly": true,
  "description": "The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}

{
  "enum": [
    "pending",
    "error",
    "success",
    "outdated"
  ],
  "type": "string",
  "description": "The status of an autofix."
}

{
  "type": "object",
  "title": "CodeQL Database",
  "required": [
    "id",
    "name",
    "language",
    "uploader",
    "content_type",
    "size",
    "created_at",
    "updated_at",
    "url"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the CodeQL database."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
    },
    "name": {
      "type": "string",
      "description": "The name of the CodeQL database."
    },
    "size": {
      "type": "integer",
      "description": "The size of the CodeQL database file in bytes."
    },
    "language": {
      "type": "string",
      "description": "The language of the CodeQL database."
    },
    "uploader": {
      "$ref": "#/components/schemas/simple-user"
    },
    "commit_oid": {
      "type": "string",
      "nullable": true,
      "description": "The commit SHA of the repository at the time the CodeQL database was created."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "content_type": {
      "type": "string",
      "description": "The MIME type of the CodeQL database file."
    }
  },
  "description": "A CodeQL database."
}

{
  "type": "object",
  "properties": {
    "state": {
      "enum": [
        "configured",
        "not-configured"
      ],
      "type": "string",
      "description": "Code scanning default setup has been configured or not."
    },
    "schedule": {
      "enum": [
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "The frequency of the periodic analysis."
    },
    "languages": {
      "type": "array",
      "items": {
        "enum": [
          "actions",
          "c-cpp",
          "csharp",
          "go",
          "java-kotlin",
          "javascript-typescript",
          "javascript",
          "python",
          "ruby",
          "typescript",
          "swift"
        ],
        "type": "string"
      },
      "description": "Languages to be analyzed."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2023-12-06T14:20:20.000Z",
      "nullable": true,
      "description": "Timestamp of latest configuration update."
    },
    "query_suite": {
      "enum": [
        "default",
        "extended"
      ],
      "type": "string",
      "description": "CodeQL query suite to be used."
    },
    "runner_type": {
      "enum": [
        "standard",
        "labeled"
      ],
      "type": "string",
      "nullable": true,
      "description": "Runner type to be used."
    },
    "runner_label": {
      "type": "string",
      "example": "code-scanning",
      "nullable": true,
      "description": "Runner label to be used if the runner type is labeled."
    },
    "threat_model": {
      "enum": [
        "remote",
        "remote_and_local"
      ],
      "type": "string",
      "description": "Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input."
    }
  },
  "description": "Configuration for code scanning default setup.",
  "x-github-breaking-changes": [
    {
      "patch": {
        "properties": {
          "languages": {
            "items": {
              "enum": [
                "actions",
                "c-cpp",
                "csharp",
                "go",
                "java-kotlin",
                "javascript-typescript",
                "python",
                "ruby",
                "swift"
              ]
            }
          }
        }
      },
      "version": "2026-03-10",
      "changeset": "remove_single_js_ts"
    }
  ]
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "runner_type": {
      "enum": [
        "standard",
        "labeled",
        "not_set"
      ],
      "type": "string",
      "description": "Whether to use labeled runners or standard GitHub runners."
    },
    "runner_label": {
      "type": "string",
      "nullable": true,
      "description": "The label of the runner to use for code scanning default setup when runner_type is 'labeled'."
    }
  },
  "description": "Feature options for code scanning default setup"
}

{
  "type": "object",
  "properties": {
    "state": {
      "enum": [
        "configured",
        "not-configured"
      ],
      "type": "string",
      "description": "The desired state of code scanning default setup."
    },
    "languages": {
      "type": "array",
      "items": {
        "enum": [
          "actions",
          "c-cpp",
          "csharp",
          "go",
          "java-kotlin",
          "javascript-typescript",
          "python",
          "ruby",
          "swift"
        ],
        "type": "string"
      },
      "description": "CodeQL languages to be analyzed."
    },
    "query_suite": {
      "enum": [
        "default",
        "extended"
      ],
      "type": "string",
      "description": "CodeQL query suite to be used."
    },
    "runner_type": {
      "enum": [
        "standard",
        "labeled"
      ],
      "type": "string",
      "description": "Runner type to be used."
    },
    "runner_label": {
      "type": "string",
      "example": "code-scanning",
      "nullable": true,
      "description": "Runner label to be used if the runner type is labeled."
    },
    "threat_model": {
      "enum": [
        "remote",
        "remote_and_local"
      ],
      "type": "string",
      "description": "Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input."
    }
  },
  "description": "Configuration for code scanning default setup.",
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "run_id": {
      "type": "integer",
      "description": "ID of the corresponding run."
    },
    "run_url": {
      "type": "string",
      "description": "URL of the corresponding run."
    }
  },
  "description": "You can use `run_url` to track the status of the run. This includes a property status and conclusion.\nYou should not rely on this always being an actions workflow run object."
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "allow_advanced": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether to allow repos which use advanced setup"
    }
  },
  "description": "Security Configuration feature options for code scanning"
}

{
  "type": "object",
  "required": [
    "number",
    "created_at",
    "url",
    "html_url",
    "instances_url",
    "state",
    "dismissed_by",
    "dismissed_at",
    "dismissed_reason",
    "rule",
    "tool",
    "most_recent_instance",
    "repository"
  ],
  "properties": {
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "rule": {
      "$ref": "#/components/schemas/code-scanning-alert-rule-summary"
    },
    "tool": {
      "$ref": "#/components/schemas/code-scanning-analysis-tool"
    },
    "state": {
      "$ref": "#/components/schemas/code-scanning-alert-state"
    },
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "assignees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      }
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "repository": {
      "$ref": "#/components/schemas/simple-repository"
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "instances_url": {
      "$ref": "#/components/schemas/alert-instances-url"
    },
    "dismissed_reason": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-reason"
    },
    "dismissed_comment": {
      "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment"
    },
    "most_recent_instance": {
      "$ref": "#/components/schemas/code-scanning-alert-instance"
    },
    "dismissal_approved_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    }
  }
}

{
  "type": "string",
  "description": "The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,\n`refs/heads/<branch name>` or simply `<branch name>`."
}

{
  "type": "string",
  "example": "refs/heads/main",
  "pattern": "^refs/(heads|tags|pull)/.*$",
  "description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/tags/<tag>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
}

{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/code-scanning-analysis-sarif-id"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "readOnly": true,
      "description": "The REST API URL for checking the status of the upload."
    }
  }
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "readOnly": true,
      "description": "Any errors that ocurred during processing of the delivery."
    },
    "analyses_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "readOnly": true,
      "description": "The REST API URL for getting the analyses associated with the upload."
    },
    "processing_status": {
      "enum": [
        "pending",
        "complete",
        "failed"
      ],
      "type": "string",
      "description": "`pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed."
    }
  }
}

{
  "type": "object",
  "title": "Variant Analysis",
  "required": [
    "id",
    "controller_repo",
    "actor",
    "query_language",
    "query_pack_url",
    "status"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the variant analysis."
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "status": {
      "enum": [
        "in_progress",
        "succeeded",
        "failed",
        "cancelled"
      ],
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available."
    },
    "failure_reason": {
      "enum": [
        "no_repos_queried",
        "actions_workflow_run_failed",
        "internal_error"
      ],
      "type": "string",
      "description": "The reason for a failure of the variant analysis. This is only available if the variant analysis has failed."
    },
    "query_language": {
      "$ref": "#/components/schemas/code-scanning-variant-analysis-language"
    },
    "query_pack_url": {
      "type": "string",
      "description": "The download url for the query pack."
    },
    "controller_repo": {
      "$ref": "#/components/schemas/simple-repository"
    },
    "scanned_repositories": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "repository",
          "analysis_status"
        ],
        "properties": {
          "repository": {
            "$ref": "#/components/schemas/code-scanning-variant-analysis-repository"
          },
          "result_count": {
            "type": "integer",
            "description": "The number of results in the case of a successful analysis. This is only available for successful analyses."
          },
          "analysis_status": {
            "$ref": "#/components/schemas/code-scanning-variant-analysis-status"
          },
          "failure_message": {
            "type": "string",
            "description": "The reason of the failure of this repo task. This is only available if the repository task has failed."
          },
          "artifact_size_in_bytes": {
            "type": "integer",
            "description": "The size of the artifact. This is only available for successful analyses."
          }
        }
      }
    },
    "skipped_repositories": {
      "type": "object",
      "required": [
        "access_mismatch_repos",
        "not_found_repos",
        "no_codeql_db_repos",
        "over_limit_repos"
      ],
      "properties": {
        "not_found_repos": {
          "type": "object",
          "required": [
            "repository_count",
            "repository_full_names"
          ],
          "properties": {
            "repository_count": {
              "type": "integer",
              "example": 2,
              "description": "The total number of repositories that were skipped for this reason."
            },
            "repository_full_names": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "A list of full repository names that were skipped. This list may not include all repositories that were skipped."
            }
          }
        },
        "over_limit_repos": {
          "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group"
        },
        "no_codeql_db_repos": {
          "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group"
        },
        "access_mismatch_repos": {
          "$ref": "#/components/schemas/code-scanning-variant-analysis-skipped-repo-group"
        }
      },
      "description": "Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis."
    },
    "actions_workflow_run_id": {
      "type": "integer",
      "description": "The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started."
    }
  },
  "description": "A run of a CodeQL query against one or more repositories."
}

{
  "enum": [
    "actions",
    "cpp",
    "csharp",
    "go",
    "java",
    "javascript",
    "python",
    "ruby",
    "rust",
    "swift"
  ],
  "type": "string",
  "description": "The language targeted by the CodeQL query"
}

{
  "type": "object",
  "required": [
    "repository",
    "analysis_status"
  ],
  "properties": {
    "repository": {
      "$ref": "#/components/schemas/simple-repository"
    },
    "artifact_url": {
      "type": "string",
      "description": "The URL of the artifact. This is only available for successful analyses."
    },
    "result_count": {
      "type": "integer",
      "description": "The number of results in the case of a successful analysis. This is only available for successful analyses."
    },
    "analysis_status": {
      "$ref": "#/components/schemas/code-scanning-variant-analysis-status"
    },
    "failure_message": {
      "type": "string",
      "description": "The reason of the failure of this repo task. This is only available if the repository task has failed."
    },
    "database_commit_sha": {
      "type": "string",
      "description": "The SHA of the commit the CodeQL database was built against. This is only available for successful analyses."
    },
    "artifact_size_in_bytes": {
      "type": "integer",
      "description": "The size of the artifact. This is only available for successful analyses."
    },
    "source_location_prefix": {
      "type": "string",
      "description": "The source location prefix to use. This is only available for successful analyses."
    }
  }
}

{
  "type": "object",
  "title": "Repository Identifier",
  "required": [
    "full_name",
    "id",
    "name",
    "private",
    "stargazers_count",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 1296269,
      "description": "A unique identifier of the repository."
    },
    "name": {
      "type": "string",
      "example": "Hello-World",
      "description": "The name of the repository."
    },
    "private": {
      "type": "boolean",
      "description": "Whether the repository is private."
    },
    "full_name": {
      "type": "string",
      "example": "octocat/Hello-World",
      "description": "The full, globally unique, name of the repository."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:14:43Z",
      "nullable": true
    },
    "stargazers_count": {
      "type": "integer",
      "example": 80
    }
  },
  "description": "Repository Identifier"
}

{
  "type": "object",
  "required": [
    "repository_count",
    "repositories"
  ],
  "properties": {
    "repositories": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/code-scanning-variant-analysis-repository"
      },
      "description": "A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it."
    },
    "repository_count": {
      "type": "integer",
      "example": 2,
      "description": "The total number of repositories that were skipped for this reason."
    }
  }
}

{
  "enum": [
    "pending",
    "in_progress",
    "succeeded",
    "failed",
    "canceled",
    "timed_out"
  ],
  "type": "string",
  "description": "The new status of the CodeQL variant analysis repository task."
}

{
  "type": "object",
  "title": "Code Search Result Item",
  "required": [
    "score",
    "name",
    "path",
    "sha",
    "git_url",
    "html_url",
    "url",
    "repository"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "score": {
      "type": "number"
    },
    "git_url": {
      "type": "string",
      "format": "uri"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "language": {
      "type": "string",
      "nullable": true
    },
    "file_size": {
      "type": "integer"
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "line_numbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "73..77",
        "77..78"
      ]
    },
    "text_matches": {
      "$ref": "#/components/schemas/search-result-text-matches"
    },
    "last_modified_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "description": "Code Search Result Item"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The ID of the code security configuration"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the configuration"
    },
    "name": {
      "type": "string",
      "description": "The name of the code security configuration. Must be unique within the organization."
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the configuration"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "description": {
      "type": "string",
      "description": "A description of the code security configuration"
    },
    "enforcement": {
      "enum": [
        "enforced",
        "unenforced"
      ],
      "type": "string",
      "description": "The enforcement status for a security configuration"
    },
    "target_type": {
      "enum": [
        "global",
        "organization",
        "enterprise"
      ],
      "type": "string",
      "description": "The type of the code security configuration."
    },
    "secret_scanning": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning"
    },
    "dependency_graph": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of Dependency Graph"
    },
    "advanced_security": {
      "enum": [
        "enabled",
        "disabled",
        "code_security",
        "secret_protection"
      ],
      "type": "string",
      "description": "The enablement status of GitHub Advanced Security"
    },
    "dependabot_alerts": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of Dependabot alerts"
    },
    "code_scanning_options": {
      "type": "object",
      "nullable": true,
      "properties": {
        "allow_advanced": {
          "type": "boolean",
          "nullable": true,
          "description": "Whether to allow repos which use advanced setup"
        }
      },
      "description": "Feature options for code scanning"
    },
    "code_scanning_default_setup": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of code scanning default setup"
    },
    "dependabot_security_updates": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of Dependabot security updates"
    },
    "private_vulnerability_reporting": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of private vulnerability reporting"
    },
    "secret_scanning_generic_secrets": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of Copilot secret scanning"
    },
    "secret_scanning_push_protection": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning push protection"
    },
    "secret_scanning_validity_checks": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning validity checks"
    },
    "secret_scanning_delegated_bypass": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning delegated bypass"
    },
    "secret_scanning_extended_metadata": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning extended metadata"
    },
    "dependency_graph_autosubmit_action": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of Automatic dependency submission"
    },
    "code_scanning_default_setup_options": {
      "type": "object",
      "nullable": true,
      "properties": {
        "runner_type": {
          "enum": [
            "standard",
            "labeled",
            "not_set"
          ],
          "type": "string",
          "nullable": true,
          "description": "Whether to use labeled runners or standard GitHub runners."
        },
        "runner_label": {
          "type": "string",
          "nullable": true,
          "description": "The label of the runner to use for code scanning when runner_type is 'labeled'."
        }
      },
      "description": "Feature options for code scanning default setup"
    },
    "dependabot_delegated_alert_dismissal": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "nullable": true,
      "description": "The enablement status of Dependabot delegated alert dismissal"
    },
    "secret_scanning_non_provider_patterns": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning non-provider patterns"
    },
    "code_scanning_delegated_alert_dismissal": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of code scanning delegated alert dismissal"
    },
    "secret_scanning_delegated_bypass_options": {
      "type": "object",
      "properties": {
        "reviewers": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "reviewer_id",
              "reviewer_type"
            ],
            "properties": {
              "mode": {
                "enum": [
                  "ALWAYS",
                  "EXEMPT"
                ],
                "type": "string",
                "default": "ALWAYS",
                "description": "The bypass mode for the reviewer"
              },
              "reviewer_id": {
                "type": "integer",
                "description": "The ID of the team or role selected as a bypass reviewer"
              },
              "reviewer_type": {
                "enum": [
                  "TEAM",
                  "ROLE"
                ],
                "type": "string",
                "description": "The type of the bypass reviewer"
              },
              "security_configuration_id": {
                "type": "integer",
                "description": "The ID of the security configuration associated with this bypass reviewer"
              }
            }
          },
          "description": "The bypass reviewers for secret scanning delegated bypass"
        }
      },
      "description": "Feature options for secret scanning delegated bypass"
    },
    "secret_scanning_delegated_alert_dismissal": {
      "enum": [
        "enabled",
        "disabled",
        "not_set"
      ],
      "type": "string",
      "description": "The enablement status of secret scanning delegated alert dismissal"
    },
    "dependency_graph_autosubmit_action_options": {
      "type": "object",
      "properties": {
        "labeled_runners": {
          "type": "boolean",
          "description": "Whether to use runners labeled with 'dependency-submission' or standard GitHub runners."
        }
      },
      "description": "Feature options for Automatic dependency submission"
    }
  },
  "description": "A code security configuration"
}

{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "attached",
        "attaching",
        "detached",
        "removed",
        "enforced",
        "failed",
        "updating",
        "removed_by_enterprise"
      ],
      "type": "string",
      "description": "The attachment status of the code security configuration on the repository."
    },
    "configuration": {
      "$ref": "#/components/schemas/code-security-configuration"
    }
  },
  "description": "Code security configuration associated with a repository and attachment status"
}

{
  "type": "object",
  "properties": {
    "status": {
      "enum": [
        "attached",
        "attaching",
        "detached",
        "removed",
        "enforced",
        "failed",
        "updating",
        "removed_by_enterprise"
      ],
      "type": "string",
      "description": "The attachment status of the code security configuration on the repository."
    },
    "repository": {
      "$ref": "#/components/schemas/simple-repository"
    }
  },
  "description": "Repositories associated with a code security configuration and attachment status"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "configuration": {
        "$ref": "#/components/schemas/code-security-configuration"
      },
      "default_for_new_repos": {
        "enum": [
          "public",
          "private_and_internal",
          "all"
        ],
        "description": "The visibility of newly created repositories for which the code security configuration will be applied to by default"
      }
    }
  },
  "description": "A list of default code security configurations"
}

{
  "type": "object",
  "title": "CODEOWNERS errors",
  "required": [
    "errors"
  ],
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "line",
          "column",
          "kind",
          "message",
          "path"
        ],
        "properties": {
          "kind": {
            "type": "string",
            "example": "Invalid owner",
            "description": "The type of error."
          },
          "line": {
            "type": "integer",
            "example": 7,
            "description": "The line number where this errors occurs."
          },
          "path": {
            "type": "string",
            "example": ".github/CODEOWNERS",
            "description": "The path of the file where the error occured."
          },
          "column": {
            "type": "integer",
            "example": 3,
            "description": "The column number where this errors occurs."
          },
          "source": {
            "type": "string",
            "example": "* user",
            "description": "The contents of the line where the error occurs."
          },
          "message": {
            "type": "string",
            "example": "Invalid owner on line 7:\n\n  * user\n    ^",
            "description": "A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting)."
          },
          "suggestion": {
            "type": "string",
            "example": "The pattern `/` will never match anything, did you mean `*` instead?",
            "nullable": true,
            "description": "Suggested action to fix the error. This will usually be `null`, but is provided for some common errors."
          }
        }
      }
    }
  },
  "description": "A list of errors found in a repo's CODEOWNERS file"
}

{
  "type": "object",
  "title": "Codespace",
  "required": [
    "id",
    "name",
    "environment_id",
    "owner",
    "billable_owner",
    "repository",
    "machine",
    "prebuild",
    "created_at",
    "updated_at",
    "last_used_at",
    "state",
    "url",
    "git_status",
    "location",
    "idle_timeout_minutes",
    "web_url",
    "machines_url",
    "start_url",
    "stop_url",
    "pulls_url",
    "recent_folders"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for this codespace."
    },
    "name": {
      "type": "string",
      "example": "monalisa-octocat-hello-world-g4wpq6h95q",
      "description": "Automatically generated name of this codespace."
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "state": {
      "enum": [
        "Unknown",
        "Created",
        "Queued",
        "Provisioning",
        "Available",
        "Awaiting",
        "Unavailable",
        "Deleted",
        "Moved",
        "Shutdown",
        "Archived",
        "Starting",
        "ShuttingDown",
        "Failed",
        "Exporting",
        "Updating",
        "Rebuilding"
      ],
      "type": "string",
      "example": "Available",
      "description": "State of this codespace."
    },
    "machine": {
      "$ref": "#/components/schemas/nullable-codespace-machine"
    },
    "web_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to access this codespace on the web."
    },
    "location": {
      "enum": [
        "EastUs",
        "SouthEastAsia",
        "WestEurope",
        "WestUs2"
      ],
      "type": "string",
      "example": "WestUs2",
      "description": "The initally assigned location of a new codespace."
    },
    "prebuild": {
      "type": "boolean",
      "example": false,
      "nullable": true,
      "description": "Whether the codespace was created from a prebuild."
    },
    "stop_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to stop this codespace."
    },
    "pulls_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "API URL for the Pull Request associated with this codespace, if any."
    },
    "start_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to start this codespace."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z"
    },
    "git_status": {
      "type": "object",
      "properties": {
        "ref": {
          "type": "string",
          "example": "main",
          "description": "The current branch (or SHA if in detached HEAD state) of the local repository."
        },
        "ahead": {
          "type": "integer",
          "example": 0,
          "description": "The number of commits the local repository is ahead of the remote."
        },
        "behind": {
          "type": "integer",
          "example": 0,
          "description": "The number of commits the local repository is behind the remote."
        },
        "has_unpushed_changes": {
          "type": "boolean",
          "description": "Whether the local repository has unpushed changes."
        },
        "has_uncommitted_changes": {
          "type": "boolean",
          "description": "Whether the local repository has uncommitted changes."
        }
      },
      "description": "Details about the codespace's git repository."
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z"
    },
    "publish_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "API URL to publish this codespace to a new repository."
    },
    "display_name": {
      "type": "string",
      "example": "bookish space pancake",
      "nullable": true,
      "description": "Display name for this codespace."
    },
    "last_used_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z",
      "description": "Last known time this codespace was started."
    },
    "machines_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to access available alternate machine types for this codespace."
    },
    "billable_owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "environment_id": {
      "type": "string",
      "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
      "nullable": true,
      "description": "UUID identifying this codespace's environment."
    },
    "recent_folders": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "devcontainer_path": {
      "type": "string",
      "example": ".devcontainer/example/devcontainer.json",
      "nullable": true,
      "description": "Path to devcontainer.json from repo root used to create Codespace."
    },
    "pending_operation": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it."
    },
    "idle_timeout_notice": {
      "type": "string",
      "nullable": true,
      "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy"
    },
    "runtime_constraints": {
      "type": "object",
      "properties": {
        "allowed_port_privacy_settings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "nullable": true,
          "description": "The privacy settings a user can select from when forwarding a port."
        }
      }
    },
    "idle_timeout_minutes": {
      "type": "integer",
      "example": 60,
      "nullable": true,
      "description": "The number of minutes of inactivity after which this codespace will be automatically stopped."
    },
    "retention_expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T20:01:12Z",
      "nullable": true,
      "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\""
    },
    "last_known_stop_notice": {
      "type": "string",
      "example": "you've used 100% of your spending limit for Codespaces",
      "nullable": true,
      "description": "The text to display to a user when a codespace has been stopped for a potentially actionable reason."
    },
    "retention_period_minutes": {
      "type": "integer",
      "example": 60,
      "nullable": true,
      "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)."
    },
    "pending_operation_disabled_reason": {
      "type": "string",
      "nullable": true,
      "description": "Text to show user when codespace is disabled by a pending operation"
    }
  },
  "description": "A codespace."
}

{
  "type": "object",
  "title": "Fetches information about an export of a codespace.",
  "properties": {
    "id": {
      "type": "string",
      "example": "latest",
      "description": "Id for the export details"
    },
    "sha": {
      "type": "string",
      "example": "fd95a81ca01e48ede9f39c799ecbcef817b8a3b2",
      "nullable": true,
      "description": "Git commit SHA of the exported branch"
    },
    "state": {
      "type": "string",
      "example": "succeeded | failed | in_progress",
      "nullable": true,
      "description": "State of the latest export"
    },
    "branch": {
      "type": "string",
      "example": "codespace-monalisa-octocat-hello-world-g4wpq6h95q",
      "nullable": true,
      "description": "Name of the exported branch"
    },
    "html_url": {
      "type": "string",
      "example": "https://github.com/octocat/hello-world/tree/:branch",
      "nullable": true,
      "description": "Web url for the exported branch"
    },
    "export_url": {
      "type": "string",
      "example": "https://api.github.com/user/codespaces/:name/exports/latest",
      "description": "Url for fetching export details"
    },
    "completed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2021-01-01T19:01:12Z",
      "nullable": true,
      "description": "Completion time of the last export operation"
    }
  },
  "description": "An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest"
}

{
  "type": "object",
  "title": "Codespace machine",
  "required": [
    "name",
    "display_name",
    "operating_system",
    "storage_in_bytes",
    "memory_in_bytes",
    "cpus",
    "prebuild_availability"
  ],
  "properties": {
    "cpus": {
      "type": "integer",
      "example": 4,
      "description": "How many cores are available to the codespace."
    },
    "name": {
      "type": "string",
      "example": "standardLinux",
      "description": "The name of the machine."
    },
    "display_name": {
      "type": "string",
      "example": "4 cores, 16 GB RAM, 64 GB storage",
      "description": "The display name of the machine includes cores, memory, and storage."
    },
    "memory_in_bytes": {
      "type": "integer",
      "example": 17179869184,
      "description": "How much memory is available to the codespace."
    },
    "operating_system": {
      "type": "string",
      "example": "linux",
      "description": "The operating system of the machine."
    },
    "storage_in_bytes": {
      "type": "integer",
      "example": 68719476736,
      "description": "How much storage is available to the codespace."
    },
    "prebuild_availability": {
      "enum": [
        "none",
        "ready",
        "in_progress"
      ],
      "type": "string",
      "example": "ready",
      "nullable": true,
      "description": "Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be \"null\" if prebuilds are not supported or prebuild availability could not be determined. Value will be \"none\" if no prebuild is available. Latest values \"ready\" and \"in_progress\" indicate the prebuild availability status."
    }
  },
  "description": "A description of the machine powering a codespace."
}

{
  "type": "object",
  "title": "Codespace",
  "required": [
    "id",
    "name",
    "environment_id",
    "owner",
    "billable_owner",
    "repository",
    "machine",
    "prebuild",
    "created_at",
    "updated_at",
    "last_used_at",
    "state",
    "url",
    "git_status",
    "location",
    "idle_timeout_minutes",
    "web_url",
    "machines_url",
    "start_url",
    "stop_url",
    "pulls_url",
    "recent_folders"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "API URL for this codespace."
    },
    "name": {
      "type": "string",
      "example": "monalisa-octocat-hello-world-g4wpq6h95q",
      "description": "Automatically generated name of this codespace."
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "state": {
      "enum": [
        "Unknown",
        "Created",
        "Queued",
        "Provisioning",
        "Available",
        "Awaiting",
        "Unavailable",
        "Deleted",
        "Moved",
        "Shutdown",
        "Archived",
        "Starting",
        "ShuttingDown",
        "Failed",
        "Exporting",
        "Updating",
        "Rebuilding"
      ],
      "type": "string",
      "example": "Available",
      "description": "State of this codespace."
    },
    "machine": {
      "$ref": "#/components/schemas/nullable-codespace-machine"
    },
    "web_url": {
      "type": "string",
      "format": "uri",
      "description": "URL to access this codespace on the web."
    },
    "location": {
      "enum": [
        "EastUs",
        "SouthEastAsia",
        "WestEurope",
        "WestUs2"
      ],
      "type": "string",
      "example": "WestUs2",
      "description": "The initally assigned location of a new codespace."
    },
    "prebuild": {
      "type": "boolean",
      "example": false,
      "nullable": true,
      "description": "Whether the codespace was created from a prebuild."
    },
    "stop_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to stop this codespace."
    },
    "pulls_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "API URL for the Pull Request associated with this codespace, if any."
    },
    "start_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to start this codespace."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z"
    },
    "git_status": {
      "type": "object",
      "properties": {
        "ref": {
          "type": "string",
          "example": "main",
          "description": "The current branch (or SHA if in detached HEAD state) of the local repository."
        },
        "ahead": {
          "type": "integer",
          "example": 0,
          "description": "The number of commits the local repository is ahead of the remote."
        },
        "behind": {
          "type": "integer",
          "example": 0,
          "description": "The number of commits the local repository is behind the remote."
        },
        "has_unpushed_changes": {
          "type": "boolean",
          "description": "Whether the local repository has unpushed changes."
        },
        "has_uncommitted_changes": {
          "type": "boolean",
          "description": "Whether the local repository has uncommitted changes."
        }
      },
      "description": "Details about the codespace's git repository."
    },
    "repository": {
      "$ref": "#/components/schemas/full-repository"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z"
    },
    "publish_url": {
      "type": "string",
      "format": "uri",
      "nullable": true,
      "description": "API URL to publish this codespace to a new repository."
    },
    "display_name": {
      "type": "string",
      "example": "bookish space pancake",
      "nullable": true,
      "description": "Display name for this codespace."
    },
    "last_used_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z",
      "description": "Last known time this codespace was started."
    },
    "machines_url": {
      "type": "string",
      "format": "uri",
      "description": "API URL to access available alternate machine types for this codespace."
    },
    "billable_owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "environment_id": {
      "type": "string",
      "example": "26a7c758-7299-4a73-b978-5a92a7ae98a0",
      "nullable": true,
      "description": "UUID identifying this codespace's environment."
    },
    "recent_folders": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "devcontainer_path": {
      "type": "string",
      "example": ".devcontainer/example/devcontainer.json",
      "nullable": true,
      "description": "Path to devcontainer.json from repo root used to create Codespace."
    },
    "pending_operation": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it."
    },
    "idle_timeout_notice": {
      "type": "string",
      "nullable": true,
      "description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy"
    },
    "runtime_constraints": {
      "type": "object",
      "properties": {
        "allowed_port_privacy_settings": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "nullable": true,
          "description": "The privacy settings a user can select from when forwarding a port."
        }
      }
    },
    "idle_timeout_minutes": {
      "type": "integer",
      "example": 60,
      "nullable": true,
      "description": "The number of minutes of inactivity after which this codespace will be automatically stopped."
    },
    "retention_expires_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T20:01:12Z",
      "nullable": true,
      "description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\""
    },
    "retention_period_minutes": {
      "type": "integer",
      "example": 60,
      "nullable": true,
      "description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days)."
    },
    "pending_operation_disabled_reason": {
      "type": "string",
      "nullable": true,
      "description": "Text to show user when codespace is disabled by a pending operation"
    }
  },
  "description": "A codespace."
}

{
  "type": "object",
  "title": "Codespaces Secret",
  "required": [
    "name",
    "created_at",
    "updated_at",
    "visibility"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "SECRET_NAME",
      "description": "The name of the secret"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "visibility": {
      "enum": [
        "all",
        "private",
        "selected"
      ],
      "type": "string",
      "description": "The type of repositories in the organization that the secret is visible to"
    },
    "selected_repositories_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/orgs/ORGANIZATION/codespaces/secrets/SECRET_NAME/repositories",
      "description": "The API URL at which the list of repositories this secret is visible to can be retrieved"
    }
  },
  "description": "Secrets for a GitHub Codespace."
}

{
  "type": "object",
  "title": "Codespaces Permissions Check",
  "required": [
    "accepted"
  ],
  "properties": {
    "accepted": {
      "type": "boolean",
      "example": true,
      "description": "Whether the user has accepted the permissions defined by the devcontainer config"
    }
  },
  "description": "Permission check result for a given devcontainer config."
}

{
  "type": "object",
  "title": "CodespacesPublicKey",
  "required": [
    "key_id",
    "key"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 2
    },
    "key": {
      "type": "string",
      "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
      "description": "The Base64 encoded public key."
    },
    "url": {
      "type": "string",
      "example": "https://api.github.com/user/keys/2"
    },
    "title": {
      "type": "string",
      "example": "ssh-rsa AAAAB3NzaC1yc2EAAA"
    },
    "key_id": {
      "type": "string",
      "example": "1234567",
      "description": "The identifier for the key."
    },
    "created_at": {
      "type": "string",
      "example": "2011-01-26T19:01:12Z"
    }
  },
  "description": "The public key used for setting Codespaces secrets."
}

{
  "type": "object",
  "title": "Codespaces Secret",
  "required": [
    "name",
    "created_at",
    "updated_at",
    "visibility",
    "selected_repositories_url"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "SECRET_NAME",
      "description": "The name of the secret"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
    },
    "visibility": {
      "enum": [
        "all",
        "private",
        "selected"
      ],
      "type": "string",
      "description": "The type of repositories in the organization that the secret is visible to"
    },
    "selected_repositories_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/user/secrets/SECRET_NAME/repositories",
      "description": "The API URL at which the list of repositories this secret is visible to can be retrieved"
    }
  },
  "description": "Secrets for a GitHub Codespace."
}

{
  "type": "object",
  "title": "CodespacesUserPublicKey",
  "required": [
    "key_id",
    "key"
  ],
  "properties": {
    "key": {
      "type": "string",
      "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
      "description": "The Base64 encoded public key."
    },
    "key_id": {
      "type": "string",
      "example": "1234567",
      "description": "The identifier for the key."
    }
  },
  "description": "The public key used for setting user Codespaces' Secrets."
}

{
  "type": "object",
  "title": "Collaborator",
  "required": [
    "avatar_url",
    "events_url",
    "followers_url",
    "following_url",
    "gists_url",
    "gravatar_id",
    "html_url",
    "id",
    "node_id",
    "login",
    "organizations_url",
    "received_events_url",
    "repos_url",
    "site_admin",
    "starred_url",
    "subscriptions_url",
    "type",
    "url",
    "role_name"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat"
    },
    "name": {
      "type": "string",
      "nullable": true
    },
    "type": {
      "type": "string",
      "example": "User"
    },
    "email": {
      "type": "string",
      "nullable": true
    },
    "login": {
      "type": "string",
      "example": "octocat"
    },
    "node_id": {
      "type": "string",
      "example": "MDQ6VXNlcjE="
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat"
    },
    "gists_url": {
      "type": "string",
      "example": "https://api.github.com/users/octocat/gists{/gist_id}"
    },
    "repos_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/repos"
    },
    "role_name": {
      "type": "string",
      "example": "admin"
    },
    "avatar_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/images/error/octocat_happy.gif"
    },
    "events_url": {
      "type": "string",
      "example": "https://api.github.com/users/octocat/events{/privacy}"
    },
    "site_admin": {
      "type": "boolean"
    },
    "gravatar_id": {
      "type": "string",
      "example": "41d064eb2195891e12d0413f63227ea7",
      "nullable": true
    },
    "permissions": {
      "type": "object",
      "required": [
        "pull",
        "push",
        "admin"
      ],
      "properties": {
        "pull": {
          "type": "boolean"
        },
        "push": {
          "type": "boolean"
        },
        "admin": {
          "type": "boolean"
        },
        "triage": {
          "type": "boolean"
        },
        "maintain": {
          "type": "boolean"
        }
      }
    },
    "starred_url": {
      "type": "string",
      "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
    },
    "followers_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/followers"
    },
    "following_url": {
      "type": "string",
      "example": "https://api.github.com/users/octocat/following{/other_user}"
    },
    "user_view_type": {
      "type": "string",
      "example": "public"
    },
    "organizations_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/orgs"
    },
    "subscriptions_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/subscriptions"
    },
    "received_events_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/users/octocat/received_events"
    }
  },
  "description": "Collaborator"
}

{
  "type": "object",
  "title": "Combined Commit Status",
  "required": [
    "state",
    "sha",
    "total_count",
    "statuses",
    "repository",
    "commit_url",
    "url"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "state": {
      "type": "string"
    },
    "statuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-commit-status"
      }
    },
    "commit_url": {
      "type": "string",
      "format": "uri"
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "total_count": {
      "type": "integer"
    }
  },
  "description": "Combined Commit Status"
}

{
  "type": "object",
  "title": "Commit",
  "required": [
    "url",
    "sha",
    "node_id",
    "html_url",
    "comments_url",
    "commit",
    "author",
    "committer",
    "parents"
  ],
  "properties": {
    "sha": {
      "type": "string",
      "example": "6dcb09b5b57875f334f61aebed695e2e4193db5e"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
    },
    "files": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/diff-entry"
      }
    },
    "stats": {
      "type": "object",
      "properties": {
        "total": {
          "type": "integer"
        },
        "additions": {
          "type": "integer"
        },
        "deletions": {
          "type": "integer"
        }
      }
    },
    "author": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/simple-user"
        },
        {
          "$ref": "#/components/schemas/empty-object"
        }
      ],
      "nullable": true
    },
    "commit": {
      "type": "object",
      "required": [
        "author",
        "committer",
        "comment_count",
        "message",
        "tree",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "format": "uri",
          "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e"
        },
        "tree": {
          "type": "object",
          "required": [
            "sha",
            "url"
          ],
          "properties": {
            "sha": {
              "type": "string",
              "example": "827efc6d56897b048c772eb4087f854f46256132"
            },
            "url": {
              "type": "string",
              "format": "uri",
              "example": "https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132"
            }
          }
        },
        "author": {
          "$ref": "#/components/schemas/nullable-git-user"
        },
        "message": {
          "type": "string",
          "example": "Fix all the bugs"
        },
        "committer": {
          "$ref": "#/components/schemas/nullable-git-user"
        },
        "verification": {
          "$ref": "#/components/schemas/verification"
        },
        "comment_count": {
          "type": "integer",
          "example": 0
        }
      }
    },
    "node_id": {
      "type": "string",
      "example": "MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ=="
    },
    "parents": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "sha",
          "url"
        ],
        "properties": {
          "sha": {
            "type": "string",
            "example": "7638417db6d59f3c431d3e1f261cc637155684cd"
          },
          "url": {
            "type": "string",
            "format": "uri",
            "example": "https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd"
          },
          "html_url": {
            "type": "string",
            "format": "uri",
            "example": "https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd"
          }
        }
      }
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e"
    },
    "committer": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/simple-user"
        },
        {
          "$ref": "#/components/schemas/empty-object"
        }
      ],
      "nullable": true
    },
    "comments_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments"
    }
  },
  "description": "Commit"
}

{
  "type": "object",
  "title": "Commit Activity",
  "required": [
    "days",
    "total",
    "week"
  ],
  "properties": {
    "days": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "example": [
        0,
        3,
        26,
        20,
        39,
        1,
        0
      ]
    },
    "week": {
      "type": "integer",
      "example": 1336280400
    },
    "total": {
      "type": "integer",
      "example": 89
    }
  },
  "description": "Commit Activity"
}

{
  "type": "object",
  "title": "Commit Comment",
  "required": [
    "url",
    "html_url",
    "id",
    "node_id",
    "user",
    "position",
    "line",
    "path",
    "commit_id",
    "body",
    "author_association",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "body": {
      "type": "string"
    },
    "line": {
      "type": "integer",
      "nullable": true
    },
    "path": {
      "type": "string",
      "nullable": true
    },
    "user": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "node_id": {
      "type": "string"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "position": {
      "type": "integer",
      "nullable": true
    },
    "commit_id": {
      "type": "string"
    },
    "reactions": {
      "$ref": "#/components/schemas/reaction-rollup"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "author_association": {
      "$ref": "#/components/schemas/author-association"
    }
  },
  "description": "Commit Comment"
}

{
  "type": "object",
  "title": "CommitCommentEvent",
  "required": [
    "action",
    "comment"
  ],
  "properties": {
    "action": {
      "type": "string"
    },
    "comment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "body": {
          "type": "string"
        },
        "line": {
          "type": "integer",
          "nullable": true
        },
        "path": {
          "type": "string",
          "nullable": true
        },
        "user": {
          "$ref": "#/components/schemas/nullable-simple-user"
        },
        "node_id": {
          "type": "string"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "position": {
          "type": "integer",
          "nullable": true
        },
        "commit_id": {
          "type": "string"
        },
        "reactions": {
          "$ref": "#/components/schemas/reaction-rollup"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

{
  "type": "object",
  "title": "Commit Comparison",
  "required": [
    "url",
    "html_url",
    "permalink_url",
    "diff_url",
    "patch_url",
    "base_commit",
    "merge_base_commit",
    "status",
    "ahead_by",
    "behind_by",
    "total_commits",
    "commits"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/compare/master...topic"
    },
    "files": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/diff-entry"
      }
    },
    "status": {
      "enum": [
        "diverged",
        "ahead",
        "behind",
        "identical"
      ],
      "type": "string",
      "example": "ahead"
    },
    "commits": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commit"
      }
    },
    "ahead_by": {
      "type": "integer",
      "example": 4
    },
    "diff_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic.diff"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic"
    },
    "behind_by": {
      "type": "integer",
      "example": 5
    },
    "patch_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/master...topic.patch"
    },
    "base_commit": {
      "$ref": "#/components/schemas/commit"
    },
    "permalink_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17"
    },
    "total_commits": {
      "type": "integer",
      "example": 6
    },
    "merge_base_commit": {
      "$ref": "#/components/schemas/commit"
    }
  },
  "description": "Commit Comparison"
}

{
  "type": "object",
  "title": "Commit Search Result Item",
  "required": [
    "sha",
    "node_id",
    "url",
    "html_url",
    "author",
    "committer",
    "parents",
    "comments_url",
    "commit",
    "repository",
    "score"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "score": {
      "type": "number"
    },
    "author": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "commit": {
      "type": "object",
      "required": [
        "author",
        "committer",
        "comment_count",
        "message",
        "tree",
        "url"
      ],
      "properties": {
        "url": {
          "type": "string",
          "format": "uri"
        },
        "tree": {
          "type": "object",
          "required": [
            "sha",
            "url"
          ],
          "properties": {
            "sha": {
              "type": "string"
            },
            "url": {
              "type": "string",
              "format": "uri"
            }
          }
        },
        "author": {
          "type": "object",
          "required": [
            "name",
            "email",
            "date"
          ],
          "properties": {
            "date": {
              "type": "string",
              "format": "date-time"
            },
            "name": {
              "type": "string"
            },
            "email": {
              "type": "string"
            }
          }
        },
        "message": {
          "type": "string"
        },
        "committer": {
          "$ref": "#/components/schemas/nullable-git-user"
        },
        "verification": {
          "$ref": "#/components/schemas/verification"
        },
        "comment_count": {
          "type": "integer"
        }
      }
    },
    "node_id": {
      "type": "string"
    },
    "parents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sha": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "html_url": {
            "type": "string"
          }
        }
      }
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "committer": {
      "$ref": "#/components/schemas/nullable-git-user"
    },
    "repository": {
      "$ref": "#/components/schemas/minimal-repository"
    },
    "comments_url": {
      "type": "string",
      "format": "uri"
    },
    "text_matches": {
      "$ref": "#/components/schemas/search-result-text-matches"
    }
  },
  "description": "Commit Search Result Item"
}

{
  "type": "object",
  "title": "Community Profile",
  "required": [
    "health_percentage",
    "description",
    "documentation",
    "files",
    "updated_at"
  ],
  "properties": {
    "files": {
      "type": "object",
      "required": [
        "code_of_conduct",
        "code_of_conduct_file",
        "license",
        "contributing",
        "readme",
        "issue_template",
        "pull_request_template"
      ],
      "properties": {
        "readme": {
          "$ref": "#/components/schemas/nullable-community-health-file"
        },
        "license": {
          "$ref": "#/components/schemas/nullable-license-simple"
        },
        "contributing": {
          "$ref": "#/components/schemas/nullable-community-health-file"
        },
        "issue_template": {
          "$ref": "#/components/schemas/nullable-community-health-file"
        },
        "code_of_conduct": {
          "$ref": "#/components/schemas/nullable-code-of-conduct-simple"
        },
        "code_of_conduct_file": {
          "$ref": "#/components/schemas/nullable-community-health-file"
        },
        "pull_request_template": {
          "$ref": "#/components/schemas/nullable-community-health-file"
        }
      }
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2017-02-28T19:09:29Z",
      "nullable": true
    },
    "description": {
      "type": "string",
      "example": "My first repository on GitHub!",
      "nullable": true
    },
    "documentation": {
      "type": "string",
      "example": "example.com",
      "nullable": true
    },
    "health_percentage": {
      "type": "integer",
      "example": 100
    },
    "content_reports_enabled": {
      "type": "boolean",
      "example": true
    }
  },
  "description": "Community Profile"
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "_links",
      "git_url",
      "html_url",
      "download_url",
      "name",
      "path",
      "sha",
      "size",
      "type",
      "url"
    ],
    "properties": {
      "sha": {
        "type": "string"
      },
      "url": {
        "type": "string",
        "format": "uri"
      },
      "name": {
        "type": "string"
      },
      "path": {
        "type": "string"
      },
      "size": {
        "type": "integer"
      },
      "type": {
        "enum": [
          "dir",
          "file",
          "submodule",
          "symlink"
        ],
        "type": "string"
      },
      "_links": {
        "type": "object",
        "required": [
          "git",
          "html",
          "self"
        ],
        "properties": {
          "git": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "html": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "self": {
            "type": "string",
            "format": "uri"
          }
        }
      },
      "content": {
        "type": "string"
      },
      "git_url": {
        "type": "string",
        "format": "uri",
        "nullable": true
      },
      "html_url": {
        "type": "string",
        "format": "uri",
        "nullable": true
      },
      "download_url": {
        "type": "string",
        "format": "uri",
        "nullable": true
      }
    }
  },
  "title": "Content Directory",
  "description": "A list of directory items"
}

{
  "type": "object",
  "title": "Content File",
  "required": [
    "_links",
    "git_url",
    "html_url",
    "download_url",
    "name",
    "path",
    "sha",
    "size",
    "type",
    "url",
    "content",
    "encoding"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "type": {
      "enum": [
        "file"
      ],
      "type": "string"
    },
    "_links": {
      "type": "object",
      "required": [
        "git",
        "html",
        "self"
      ],
      "properties": {
        "git": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "html": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "target": {
      "type": "string",
      "example": "\"actual/actual.md\""
    },
    "content": {
      "type": "string"
    },
    "git_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "encoding": {
      "type": "string"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "submodule_git_url": {
      "type": "string",
      "example": "\"git://example.com/defunkt/dotjs.git\""
    }
  },
  "description": "Content File"
}

{
  "type": "object",
  "title": "Submodule Content",
  "required": [
    "_links",
    "git_url",
    "html_url",
    "download_url",
    "name",
    "path",
    "sha",
    "size",
    "type",
    "url",
    "submodule_git_url"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "type": {
      "enum": [
        "submodule"
      ],
      "type": "string"
    },
    "_links": {
      "type": "object",
      "required": [
        "git",
        "html",
        "self"
      ],
      "properties": {
        "git": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "html": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "git_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "submodule_git_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "An object describing a submodule"
}

{
  "type": "object",
  "title": "Symlink Content",
  "required": [
    "_links",
    "git_url",
    "html_url",
    "download_url",
    "name",
    "path",
    "sha",
    "size",
    "type",
    "url",
    "target"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "type": {
      "enum": [
        "symlink"
      ],
      "type": "string"
    },
    "_links": {
      "type": "object",
      "required": [
        "git",
        "html",
        "self"
      ],
      "properties": {
        "git": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "html": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "target": {
      "type": "string"
    },
    "git_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "description": "An object describing a symlink"
}

{
  "type": "object",
  "title": "Content Traffic",
  "required": [
    "path",
    "title",
    "uniques",
    "count"
  ],
  "properties": {
    "path": {
      "type": "string",
      "example": "/github/hubot"
    },
    "count": {
      "type": "integer",
      "example": 3542
    },
    "title": {
      "type": "string",
      "example": "github/hubot: A customizable life embetterment robot."
    },
    "uniques": {
      "type": "integer",
      "example": 2225
    }
  },
  "description": "Content Traffic"
}

{
  "type": "object",
  "title": "Content Tree",
  "required": [
    "_links",
    "git_url",
    "html_url",
    "download_url",
    "name",
    "path",
    "sha",
    "size",
    "type",
    "url"
  ],
  "properties": {
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "type": {
      "type": "string"
    },
    "_links": {
      "type": "object",
      "required": [
        "git",
        "html",
        "self"
      ],
      "properties": {
        "git": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "html": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "content": {
      "type": "string"
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "_links",
          "git_url",
          "html_url",
          "download_url",
          "name",
          "path",
          "sha",
          "size",
          "type",
          "url"
        ],
        "properties": {
          "sha": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          },
          "name": {
            "type": "string"
          },
          "path": {
            "type": "string"
          },
          "size": {
            "type": "integer"
          },
          "type": {
            "type": "string"
          },
          "_links": {
            "type": "object",
            "required": [
              "git",
              "html",
              "self"
            ],
            "properties": {
              "git": {
                "type": "string",
                "format": "uri",
                "nullable": true
              },
              "html": {
                "type": "string",
                "format": "uri",
                "nullable": true
              },
              "self": {
                "type": "string",
                "format": "uri"
              }
            }
          },
          "git_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "html_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          },
          "download_url": {
            "type": "string",
            "format": "uri",
            "nullable": true
          }
        }
      }
    },
    "git_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "encoding": {
      "type": "string"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "description": "Content Tree"
}

{
  "type": "object",
  "title": "Contributor",
  "required": [
    "contributions",
    "type"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "name": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "login": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "html_url": {
      "type": "string",
      "format": "uri"
    },
    "gists_url": {
      "type": "string"
    },
    "repos_url": {
      "type": "string",
      "format": "uri"
    },
    "avatar_url": {
      "type": "string",
      "format": "uri"
    },
    "events_url": {
      "type": "string"
    },
    "site_admin": {
      "type": "boolean"
    },
    "gravatar_id": {
      "type": "string",
      "nullable": true
    },
    "starred_url": {
      "type": "string"
    },
    "contributions": {
      "type": "integer"
    },
    "followers_url": {
      "type": "string",
      "format": "uri"
    },
    "following_url": {
      "type": "string"
    },
    "user_view_type": {
      "type": "string"
    },
    "organizations_url": {
      "type": "string",
      "format": "uri"
    },
    "subscriptions_url": {
      "type": "string",
      "format": "uri"
    },
    "received_events_url": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Contributor"
}

{
  "type": "object",
  "title": "Contributor Activity",
  "required": [
    "author",
    "total",
    "weeks"
  ],
  "properties": {
    "total": {
      "type": "integer",
      "example": 135
    },
    "weeks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "a": {
            "type": "integer"
          },
          "c": {
            "type": "integer"
          },
          "d": {
            "type": "integer"
          },
          "w": {
            "type": "integer"
          }
        }
      },
      "example": [
        {
          "a": 6898,
          "c": 10,
          "d": 77,
          "w": "1367712000"
        }
      ]
    },
    "author": {
      "$ref": "#/components/schemas/nullable-simple-user"
    }
  },
  "description": "Contributor Activity"
}

{
  "type": "object",
  "title": "Converted Note to Issue Issue Event",
  "required": [
    "id",
    "node_id",
    "url",
    "actor",
    "event",
    "commit_id",
    "commit_url",
    "created_at",
    "performed_via_github_app"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string"
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "event": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "commit_id": {
      "type": "string",
      "nullable": true
    },
    "commit_url": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "project_card": {
      "type": "object",
      "required": [
        "id",
        "url",
        "project_id",
        "project_url",
        "column_name"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "project_id": {
          "type": "integer"
        },
        "column_name": {
          "type": "string"
        },
        "project_url": {
          "type": "string",
          "format": "uri"
        },
        "previous_column_name": {
          "type": "string"
        }
      }
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/integration"
    }
  },
  "description": "Converted Note to Issue Issue Event"
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "models": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'."
          },
          "total_chats": {
            "type": "integer",
            "description": "Total number of chats initiated by users on github.com."
          },
          "is_custom_model": {
            "type": "boolean",
            "description": "Indicates whether a model is custom or default."
          },
          "total_engaged_users": {
            "type": "integer",
            "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model."
          },
          "custom_model_training_date": {
            "type": "string",
            "nullable": true,
            "description": "The training date for the custom model (if applicable)."
          }
        }
      },
      "description": "List of model metrics for a custom models and the default model."
    },
    "total_engaged_users": {
      "type": "integer",
      "description": "Total number of users who prompted Copilot Chat on github.com at least once."
    }
  },
  "description": "Usage metrics for Copilot Chat in GitHub.com",
  "additionalProperties": true
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "repositories": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Repository name"
          },
          "models": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the model used for Copilot pull request summaries. If the default model is used will appear as 'default'."
                },
                "is_custom_model": {
                  "type": "boolean",
                  "description": "Indicates whether a model is custom or default."
                },
                "total_engaged_users": {
                  "type": "integer",
                  "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model."
                },
                "custom_model_training_date": {
                  "type": "string",
                  "nullable": true,
                  "description": "The training date for the custom model."
                },
                "total_pr_summaries_created": {
                  "type": "integer",
                  "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository."
                }
              }
            },
            "description": "List of model metrics for custom models and the default model."
          },
          "total_engaged_users": {
            "type": "integer",
            "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository."
          }
        }
      },
      "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries"
    },
    "total_engaged_users": {
      "type": "integer",
      "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once."
    }
  },
  "description": "Usage metrics for Copilot for pull requests.",
  "additionalProperties": true
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "editors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the given editor."
          },
          "models": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the model used for Copilot Chat. If the default model is used will appear as 'default'."
                },
                "total_chats": {
                  "type": "integer",
                  "description": "The total number of chats initiated by users in the given editor and model."
                },
                "is_custom_model": {
                  "type": "boolean",
                  "description": "Indicates whether a model is custom or default."
                },
                "total_engaged_users": {
                  "type": "integer",
                  "description": "The number of users who prompted Copilot Chat in the given editor and model."
                },
                "total_chat_copy_events": {
                  "type": "integer",
                  "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor."
                },
                "custom_model_training_date": {
                  "type": "string",
                  "nullable": true,
                  "description": "The training date for the custom model."
                },
                "total_chat_insertion_events": {
                  "type": "integer",
                  "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor."
                }
              }
            },
            "description": "List of model metrics for custom models and the default model."
          },
          "total_engaged_users": {
            "type": "integer",
            "description": "The number of users who prompted Copilot Chat in the specified editor."
          }
        },
        "description": "Copilot Chat metrics, for active editors."
      }
    },
    "total_engaged_users": {
      "type": "integer",
      "description": "Total number of users who prompted Copilot Chat in the IDE."
    }
  },
  "description": "Usage metrics for Copilot Chat in the IDE.",
  "additionalProperties": true
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "editors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the given editor."
          },
          "models": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'."
                },
                "languages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Name of the language used for Copilot code completion suggestions, for the given editor."
                      },
                      "total_engaged_users": {
                        "type": "integer",
                        "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances."
                      },
                      "total_code_acceptances": {
                        "type": "integer",
                        "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances."
                      },
                      "total_code_suggestions": {
                        "type": "integer",
                        "description": "The number of Copilot code suggestions generated for the given editor, for the given language."
                      },
                      "total_code_lines_accepted": {
                        "type": "integer",
                        "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language."
                      },
                      "total_code_lines_suggested": {
                        "type": "integer",
                        "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language."
                      }
                    },
                    "description": "Usage metrics for a given language for the given editor for Copilot code completions."
                  },
                  "description": "Code completion metrics for active languages, for the given editor."
                },
                "is_custom_model": {
                  "type": "boolean",
                  "description": "Indicates whether a model is custom or default."
                },
                "total_engaged_users": {
                  "type": "integer",
                  "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances."
                },
                "custom_model_training_date": {
                  "type": "string",
                  "nullable": true,
                  "description": "The training date for the custom model."
                }
              }
            },
            "description": "List of model metrics for custom models and the default model."
          },
          "total_engaged_users": {
            "type": "integer",
            "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances."
          }
        },
        "description": "Copilot code completion metrics for active editors.",
        "additionalProperties": true
      }
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Name of the language used for Copilot code completion suggestions."
          },
          "total_engaged_users": {
            "type": "integer",
            "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances."
          }
        },
        "description": "Usage metrics for a given language for the given editor for Copilot code completions."
      },
      "description": "Code completion metrics for active languages."
    },
    "total_engaged_users": {
      "type": "integer",
      "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances."
    }
  },
  "description": "Usage metrics for Copilot editor code completions in the IDE.",
  "additionalProperties": true
}

{
  "type": "object",
  "title": "Copilot Organization Content Exclusion Details",
  "description": "List all Copilot Content Exclusion rules for an organization.",
  "additionalProperties": {
    "type": "array",
    "items": {
      "type": "string",
      "description": "The path to the file that will be excluded."
    }
  }
}

{
  "type": "object",
  "title": "Copilot Organization Details",
  "required": [
    "seat_breakdown",
    "public_code_suggestions",
    "seat_management_setting"
  ],
  "properties": {
    "cli": {
      "enum": [
        "enabled",
        "disabled",
        "unconfigured"
      ],
      "type": "string",
      "description": "The organization policy for allowing or disallowing Copilot CLI."
    },
    "ide_chat": {
      "enum": [
        "enabled",
        "disabled",
        "unconfigured"
      ],
      "type": "string",
      "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE."
    },
    "plan_type": {
      "enum": [
        "business",
        "enterprise"
      ],
      "type": "string",
      "description": "The Copilot plan of the organization, or the parent enterprise, when applicable."
    },
    "platform_chat": {
      "enum": [
        "enabled",
        "disabled",
        "unconfigured"
      ],
      "type": "string",
      "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com."
    },
    "seat_breakdown": {
      "$ref": "#/components/schemas/copilot-organization-seat-breakdown"
    },
    "public_code_suggestions": {
      "enum": [
        "allow",
        "block",
        "unconfigured"
      ],
      "type": "string",
      "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter)."
    },
    "seat_management_setting": {
      "enum": [
        "assign_all",
        "assign_selected",
        "disabled",
        "unconfigured"
      ],
      "type": "string",
      "description": "The mode of assigning new seats."
    }
  },
  "description": "Information about the seat breakdown and policies set for an organization with a Copilot Business or Copilot Enterprise subscription.",
  "additionalProperties": true
}

{
  "type": "object",
  "title": "Copilot Seat Breakdown",
  "properties": {
    "total": {
      "type": "integer",
      "description": "The total number of seats being billed for the organization as of the current billing cycle."
    },
    "added_this_cycle": {
      "type": "integer",
      "description": "Seats added during the current billing cycle."
    },
    "active_this_cycle": {
      "type": "integer",
      "description": "The number of seats that have used Copilot during the current billing cycle."
    },
    "pending_invitation": {
      "type": "integer",
      "description": "The number of users who have been invited to receive a Copilot seat through this organization."
    },
    "inactive_this_cycle": {
      "type": "integer",
      "description": "The number of seats that have not used Copilot during the current billing cycle."
    },
    "pending_cancellation": {
      "type": "integer",
      "description": "The number of seats that are pending cancellation at the end of the current billing cycle."
    }
  },
  "description": "The breakdown of Copilot Business seats for the organization."
}

{
  "type": "object",
  "title": "Copilot Business Seat Detail",
  "required": [
    "created_at"
  ],
  "properties": {
    "assignee": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "plan_type": {
      "enum": [
        "business",
        "enterprise",
        "unknown"
      ],
      "type": "string",
      "description": "The Copilot plan of the organization, or the parent enterprise, when applicable."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "deprecated": true,
      "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format."
    },
    "organization": {
      "$ref": "#/components/schemas/nullable-organization-simple"
    },
    "assigning_team": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/team"
        },
        {
          "$ref": "#/components/schemas/enterprise-team"
        }
      ],
      "nullable": true,
      "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable."
    },
    "last_activity_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format."
    },
    "last_activity_editor": {
      "type": "string",
      "nullable": true,
      "description": "Last editor that was used by the user for a GitHub Copilot completion."
    },
    "last_authenticated_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Timestamp of the last time the user authenticated with GitHub Copilot, in ISO 8601 format."
    },
    "pending_cancellation_date": {
      "type": "string",
      "format": "date",
      "nullable": true,
      "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle."
    }
  },
  "description": "Information about a Copilot Business seat assignment for a user, team, or organization.",
  "additionalProperties": false
}

{
  "type": "object",
  "title": "Copilot Metrics 1 Day Report",
  "required": [
    "download_links",
    "report_day"
  ],
  "properties": {
    "report_day": {
      "type": "string",
      "format": "date",
      "description": "The day of the report in `YYYY-MM-DD` format."
    },
    "download_links": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day."
    }
  },
  "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day."
}

{
  "type": "object",
  "title": "Copilot Metrics 28 Day Report",
  "required": [
    "download_links",
    "report_start_day",
    "report_end_day"
  ],
  "properties": {
    "download_links": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization."
    },
    "report_end_day": {
      "type": "string",
      "format": "date",
      "description": "The end date of the report period in `YYYY-MM-DD` format."
    },
    "report_start_day": {
      "type": "string",
      "format": "date",
      "description": "The start date of the report period in `YYYY-MM-DD` format."
    }
  },
  "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization."
}

{
  "type": "object",
  "title": "Copilot Usage Metrics",
  "required": [
    "date"
  ],
  "properties": {
    "date": {
      "type": "string",
      "format": "date",
      "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format."
    },
    "copilot_ide_chat": {
      "$ref": "#/components/schemas/copilot-ide-chat"
    },
    "total_active_users": {
      "type": "integer",
      "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint."
    },
    "copilot_dotcom_chat": {
      "$ref": "#/components/schemas/copilot-dotcom-chat"
    },
    "total_engaged_users": {
      "type": "integer",
      "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint."
    },
    "copilot_dotcom_pull_requests": {
      "$ref": "#/components/schemas/copilot-dotcom-pull-requests"
    },
    "copilot_ide_code_completions": {
      "$ref": "#/components/schemas/copilot-ide-code-completions"
    }
  },
  "description": "Copilot usage metrics for a given day.",
  "additionalProperties": true
}

{
  "type": "object",
  "title": "CreateEvent",
  "required": [
    "ref",
    "ref_type",
    "full_ref",
    "master_branch",
    "pusher_type"
  ],
  "properties": {
    "ref": {
      "type": "string"
    },
    "full_ref": {
      "type": "string"
    },
    "ref_type": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "nullable": true
    },
    "pusher_type": {
      "type": "string"
    },
    "master_branch": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Custom deployment protection rule app",
  "required": [
    "id",
    "slug",
    "integration_url",
    "node_id"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 3515,
      "description": "The unique identifier of the deployment protection rule integration."
    },
    "slug": {
      "type": "string",
      "example": "my-custom-app",
      "description": "The slugified name of the deployment protection rule integration."
    },
    "node_id": {
      "type": "string",
      "example": "MDQ6R2F0ZTM1MTU=",
      "description": "The node ID for the deployment protection rule integration."
    },
    "integration_url": {
      "type": "string",
      "example": "https://api.github.com/apps/custom-app-slug",
      "description": "The URL for the endpoint to get details about the app."
    }
  },
  "description": "A GitHub App that is providing a custom deployment protection rule."
}

{
  "type": "object",
  "title": "Organization Custom Property",
  "required": [
    "property_name",
    "value_type"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The URL that can be used to fetch, update, or delete info about this property via the API."
    },
    "required": {
      "type": "boolean",
      "description": "Whether the property is required."
    },
    "value_type": {
      "enum": [
        "string",
        "single_select",
        "multi_select",
        "true_false",
        "url"
      ],
      "type": "string",
      "example": "single_select",
      "description": "The type of the value for the property"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Short description of the property"
    },
    "source_type": {
      "enum": [
        "organization",
        "enterprise"
      ],
      "type": "string",
      "example": "organization",
      "description": "The source type of the property"
    },
    "default_value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "nullable": true,
      "description": "Default value of the property"
    },
    "property_name": {
      "type": "string",
      "description": "The name of the property"
    },
    "allowed_values": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
    },
    "values_editable_by": {
      "enum": [
        "org_actors",
        "org_and_repo_actors"
      ],
      "type": "string",
      "example": "org_actors",
      "nullable": true,
      "description": "Who can edit the values of the property"
    },
    "require_explicit_values": {
      "type": "boolean",
      "description": "Whether setting properties values is mandatory"
    }
  },
  "description": "Custom property defined on an organization"
}

{
  "type": "object",
  "title": "Custom Property Set Payload",
  "required": [
    "value_type"
  ],
  "properties": {
    "required": {
      "type": "boolean",
      "description": "Whether the property is required."
    },
    "value_type": {
      "enum": [
        "string",
        "single_select",
        "multi_select",
        "true_false",
        "url"
      ],
      "type": "string",
      "example": "single_select",
      "description": "The type of the value for the property"
    },
    "description": {
      "type": "string",
      "nullable": true,
      "description": "Short description of the property"
    },
    "default_value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "nullable": true,
      "description": "Default value of the property"
    },
    "allowed_values": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "nullable": true,
      "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
    },
    "values_editable_by": {
      "enum": [
        "org_actors",
        "org_and_repo_actors"
      ],
      "type": "string",
      "example": "org_actors",
      "nullable": true,
      "description": "Who can edit the values of the property"
    },
    "require_explicit_values": {
      "type": "boolean",
      "description": "Whether setting properties values is mandatory"
    }
  },
  "description": "Custom property set payload"
}

{
  "type": "object",
  "title": "Custom Property Value",
  "required": [
    "property_name",
    "value"
  ],
  "properties": {
    "value": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      ],
      "nullable": true,
      "description": "The value assigned to the property"
    },
    "property_name": {
      "type": "string",
      "description": "The name of the property"
    }
  },
  "description": "Custom property name and associated value"
}

{
  "type": "object",
  "nullable": true,
  "properties": {
    "cvss_v3": {
      "type": "object",
      "nullable": true,
      "required": [
        "vector_string",
        "score"
      ],
      "properties": {
        "score": {
          "type": "number",
          "maximum": 10,
          "minimum": 0,
          "nullable": true,
          "readOnly": true,
          "description": "The CVSS 3 score."
        },
        "vector_string": {
          "type": "string",
          "nullable": true,
          "description": "The CVSS 3 vector string."
        }
      }
    },
    "cvss_v4": {
      "type": "object",
      "nullable": true,
      "required": [
        "vector_string",
        "score"
      ],
      "properties": {
        "score": {
          "type": "number",
          "maximum": 10,
          "minimum": 0,
          "nullable": true,
          "readOnly": true,
          "description": "The CVSS 4 score."
        },
        "vector_string": {
          "type": "string",
          "nullable": true,
          "description": "The CVSS 4 vector string."
        }
      }
    }
  }
}

{
  "type": "object",
  "required": [
    "message",
    "id"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the deleted budget"
    },
    "message": {
      "type": "string",
      "description": "A message indicating the result of the deletion operation"
    }
  }
}

{
  "type": "object",
  "title": "DeleteEvent",
  "required": [
    "ref",
    "ref_type",
    "full_ref",
    "pusher_type"
  ],
  "properties": {
    "ref": {
      "type": "string"
    },
    "full_ref": {
      "type": "string"
    },
    "ref_type": {
      "type": "string"
    },
    "pusher_type": {
      "type": "string"
    }
  }
}

{
  "type": "object",
  "title": "Demilestoned Issue Event",
  "required": [
    "milestone",
    "id",
    "node_id",
    "url",
    "actor",
    "event",
    "commit_id",
    "commit_url",
    "created_at",
    "performed_via_github_app"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "url": {
      "type": "string"
    },
    "actor": {
      "$ref": "#/components/schemas/simple-user"
    },
    "event": {
      "type": "string"
    },
    "node_id": {
      "type": "string"
    },
    "commit_id": {
      "type": "string",
      "nullable": true
    },
    "milestone": {
      "type": "object",
      "required": [
        "title"
      ],
      "properties": {
        "title": {
          "type": "string"
        }
      }
    },
    "commit_url": {
      "type": "string",
      "nullable": true
    },
    "created_at": {
      "type": "string"
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "description": "Demilestoned Issue Event"
}

{
  "type": "object",
  "required": [
    "number",
    "state",
    "dependency",
    "security_advisory",
    "security_vulnerability",
    "url",
    "html_url",
    "created_at",
    "updated_at",
    "dismissed_at",
    "dismissed_by",
    "dismissed_reason",
    "dismissed_comment",
    "fixed_at"
  ],
  "properties": {
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "state": {
      "enum": [
        "auto_dismissed",
        "dismissed",
        "fixed",
        "open"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The state of the Dependabot alert."
    },
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "assignees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      },
      "readOnly": true,
      "description": "The users assigned to this alert."
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "dependency": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "scope": {
          "enum": [
            "development",
            "runtime"
          ],
          "type": "string",
          "nullable": true,
          "readOnly": true,
          "description": "The execution scope of the vulnerable dependency."
        },
        "package": {
          "$ref": "#/components/schemas/dependabot-alert-package"
        },
        "relationship": {
          "enum": [
            "unknown",
            "direct",
            "transitive",
            "inconclusive"
          ],
          "type": "string",
          "nullable": true,
          "readOnly": true,
          "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n"
        },
        "manifest_path": {
          "type": "string",
          "readOnly": true,
          "description": "The full path to the dependency manifest file, relative to the root of the repository."
        }
      },
      "description": "Details for the vulnerable dependency."
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "dismissed_reason": {
      "enum": [
        "fix_started",
        "inaccurate",
        "no_bandwidth",
        "not_used",
        "tolerable_risk"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason that the alert was dismissed."
    },
    "auto_dismissed_at": {
      "$ref": "#/components/schemas/alert-auto-dismissed-at"
    },
    "dismissal_request": {
      "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple"
    },
    "dismissed_comment": {
      "type": "string",
      "nullable": true,
      "maxLength": 280,
      "description": "An optional comment associated with the alert's dismissal."
    },
    "security_advisory": {
      "$ref": "#/components/schemas/dependabot-alert-security-advisory"
    },
    "security_vulnerability": {
      "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
    }
  },
  "description": "A Dependabot alert.",
  "additionalProperties": false
}

{
  "type": "object",
  "title": "Dependabot alert dismissal request",
  "nullable": true,
  "properties": {
    "id": {
      "type": "integer",
      "description": "The unique identifier of the dismissal request."
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "The API URL to get more information about this dismissal request."
    },
    "status": {
      "enum": [
        "pending",
        "approved",
        "rejected",
        "cancelled"
      ],
      "type": "string",
      "description": "The current status of the dismissal request."
    },
    "requester": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "description": "The unique identifier of the user."
        },
        "login": {
          "type": "string",
          "description": "The login name of the user."
        }
      },
      "description": "The user who requested the dismissal."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time when the dismissal request was created."
    }
  },
  "description": "Information about an active dismissal request for this Dependabot alert."
}

{
  "type": "object",
  "readOnly": true,
  "required": [
    "ecosystem",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "readOnly": true,
      "description": "The unique package name within its ecosystem."
    },
    "ecosystem": {
      "type": "string",
      "readOnly": true,
      "description": "The package's language or package management ecosystem."
    }
  },
  "description": "Details for the vulnerable package.",
  "additionalProperties": false
}

{
  "type": "object",
  "readOnly": true,
  "required": [
    "ghsa_id",
    "cve_id",
    "summary",
    "description",
    "vulnerabilities",
    "severity",
    "cvss",
    "cwes",
    "identifiers",
    "references",
    "published_at",
    "updated_at",
    "withdrawn_at"
  ],
  "properties": {
    "cvss": {
      "type": "object",
      "readOnly": true,
      "required": [
        "score",
        "vector_string"
      ],
      "properties": {
        "score": {
          "type": "number",
          "maximum": 10,
          "minimum": 0,
          "readOnly": true,
          "description": "The overall CVSS score of the advisory."
        },
        "vector_string": {
          "type": "string",
          "nullable": true,
          "readOnly": true,
          "description": "The full CVSS vector string for the advisory."
        }
      },
      "description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
      "additionalProperties": false
    },
    "cwes": {
      "type": "array",
      "items": {
        "type": "object",
        "readOnly": true,
        "required": [
          "cwe_id",
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "readOnly": true,
            "description": "The short, plain text name of the CWE."
          },
          "cwe_id": {
            "type": "string",
            "readOnly": true,
            "description": "The unique CWE ID."
          }
        },
        "description": "A CWE weakness assigned to the advisory.",
        "additionalProperties": false
      },
      "readOnly": true,
      "description": "Details for the advisory pertaining to Common Weakness Enumeration."
    },
    "epss": {
      "$ref": "#/components/schemas/security-advisory-epss"
    },
    "cve_id": {
      "type": "string",
      "nullable": true,
      "readOnly": true,
      "description": "The unique CVE ID assigned to the advisory."
    },
    "ghsa_id": {
      "type": "string",
      "readOnly": true,
      "description": "The unique GitHub Security Advisory ID assigned to the advisory."
    },
    "summary": {
      "type": "string",
      "readOnly": true,
      "maxLength": 1024,
      "description": "A short, plain text summary of the advisory."
    },
    "severity": {
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The severity of the advisory."
    },
    "references": {
      "type": "array",
      "items": {
        "type": "object",
        "readOnly": true,
        "required": [
          "url"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "readOnly": true,
            "description": "The URL of the reference."
          }
        },
        "description": "A link to additional advisory information.",
        "additionalProperties": false
      },
      "readOnly": true,
      "description": "Links to additional advisory information."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
    },
    "description": {
      "type": "string",
      "readOnly": true,
      "description": "A long-form Markdown-supported description of the advisory."
    },
    "identifiers": {
      "type": "array",
      "items": {
        "type": "object",
        "readOnly": true,
        "required": [
          "value",
          "type"
        ],
        "properties": {
          "type": {
            "enum": [
              "CVE",
              "GHSA"
            ],
            "type": "string",
            "readOnly": true,
            "description": "The type of advisory identifier."
          },
          "value": {
            "type": "string",
            "readOnly": true,
            "description": "The value of the advisory identifer."
          }
        },
        "description": "An advisory identifier.",
        "additionalProperties": false
      },
      "readOnly": true,
      "description": "Values that identify this advisory among security information sources."
    },
    "published_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true,
      "description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
    },
    "withdrawn_at": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
    },
    "classification": {
      "enum": [
        "general",
        "malware"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The classification of the advisory."
    },
    "cvss_severities": {
      "$ref": "#/components/schemas/cvss-severities"
    },
    "vulnerabilities": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
      },
      "readOnly": true,
      "description": "Vulnerable version range information for the advisory."
    }
  },
  "description": "Details for the GitHub Security Advisory.",
  "additionalProperties": false,
  "x-github-breaking-changes": [
    {
      "patch": {
        "required": [
          "ghsa_id",
          "cve_id",
          "summary",
          "description",
          "vulnerabilities",
          "severity",
          "cwes",
          "identifiers",
          "references",
          "published_at",
          "updated_at",
          "withdrawn_at"
        ],
        "properties": {
          "cvss": null
        }
      },
      "version": "2026-03-10",
      "changeset": "deprecate_cvss"
    }
  ]
}

{
  "type": "object",
  "readOnly": true,
  "required": [
    "package",
    "severity",
    "vulnerable_version_range",
    "first_patched_version"
  ],
  "properties": {
    "package": {
      "$ref": "#/components/schemas/dependabot-alert-package"
    },
    "severity": {
      "enum": [
        "low",
        "medium",
        "high",
        "critical"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The severity of the vulnerability."
    },
    "first_patched_version": {
      "type": "object",
      "nullable": true,
      "readOnly": true,
      "required": [
        "identifier"
      ],
      "properties": {
        "identifier": {
          "type": "string",
          "readOnly": true,
          "description": "The package version that patches this vulnerability."
        }
      },
      "description": "Details pertaining to the package version that patches this vulnerability.",
      "additionalProperties": false
    },
    "vulnerable_version_range": {
      "type": "string",
      "readOnly": true,
      "description": "Conditions that identify vulnerable versions of this vulnerability's package."
    }
  },
  "description": "Details pertaining to one vulnerable version range for the advisory.",
  "additionalProperties": false
}

{
  "type": "object",
  "required": [
    "number",
    "state",
    "dependency",
    "security_advisory",
    "security_vulnerability",
    "url",
    "html_url",
    "created_at",
    "updated_at",
    "dismissed_at",
    "dismissed_by",
    "dismissed_reason",
    "dismissed_comment",
    "fixed_at",
    "repository"
  ],
  "properties": {
    "url": {
      "$ref": "#/components/schemas/alert-url"
    },
    "state": {
      "enum": [
        "auto_dismissed",
        "dismissed",
        "fixed",
        "open"
      ],
      "type": "string",
      "readOnly": true,
      "description": "The state of the Dependabot alert."
    },
    "number": {
      "$ref": "#/components/schemas/alert-number"
    },
    "fixed_at": {
      "$ref": "#/components/schemas/alert-fixed-at"
    },
    "html_url": {
      "$ref": "#/components/schemas/alert-html-url"
    },
    "assignees": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/simple-user"
      },
      "readOnly": true,
      "description": "The users assigned to this alert."
    },
    "created_at": {
      "$ref": "#/components/schemas/alert-created-at"
    },
    "dependency": {
      "type": "object",
      "readOnly": true,
      "properties": {
        "scope": {
          "enum": [
            "development",
            "runtime"
          ],
          "type": "string",
          "nullable": true,
          "readOnly": true,
          "description": "The execution scope of the vulnerable dependency."
        },
        "package": {
          "$ref": "#/components/schemas/dependabot-alert-package"
        },
        "relationship": {
          "enum": [
            "unknown",
            "direct",
            "transitive",
            "inconclusive"
          ],
          "type": "string",
          "nullable": true,
          "readOnly": true,
          "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n"
        },
        "manifest_path": {
          "type": "string",
          "readOnly": true,
          "description": "The full path to the dependency manifest file, relative to the root of the repository."
        }
      },
      "description": "Details for the vulnerable dependency."
    },
    "repository": {
      "$ref": "#/components/schemas/simple-repository"
    },
    "updated_at": {
      "$ref": "#/components/schemas/alert-updated-at"
    },
    "dismissed_at": {
      "$ref": "#/components/schemas/alert-dismissed-at"
    },
    "dismissed_by": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "dismissed_reason": {
      "enum": [
        "fix_started",
        "inaccurate",
        "no_bandwidth",
        "not_used",
        "tolerable_risk"
      ],
      "type": "string",
      "nullable": true,
      "description": "The reason that the alert was dismissed."
    },
    "auto_dismissed_at": {
      "$ref": "#/components/schemas/alert-auto-dismissed-at"
    },
    "dismissal_request": {
      "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple"
    },
    "dismissed_comment": {
      "type": "string",
      "nullable": true,
      "maxLength": 280,
      "description": "An optional comment associated with the alert's dismissal."
    },
    "security_advisory": {
      "$ref": "#/components/schemas/dependabot-alert-security-advisory"
    },
    "security_vulnerability": {
      "$ref": "#/components/schemas/dependabot-alert-security-vulnerability"
    }
  },
  "description": "A Dependabot alert.",
  "additionalProperties": false
}

{
  "type": "object",
  "title": "DependabotPublicKey",
  "required": [
    "key_id",
    "key"
  ],
  "properties": {
    "key": {
      "type": "string",
      "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
      "description": "The Base64 encoded public key."
    },
    "key_id": {
      "type": "string",
      "example": "1234567",
      "description": "The identifier for the key."
    }
  },
  "description": "The public key used for setting Dependabot Secrets."
}

{
  "type": "object",
  "title": "Dependabot Repository Access Details",
  "properties": {
    "default_level": {
      "enum": [
        "public",
        "internal"
      ],
      "type": "string",
      "example": "internal",
      "nullable": true,
      "description": "The default repository access level for Dependabot updates."
    },
    "accessible_repositories": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nullable-simple-repository"
      }
    }
  },
  "description": "Information about repositories that Dependabot is able to access in an organization",
  "additionalProperties": false
}

{
  "type": "object",
  "title": "Dependabot Secret",
  "required": [
    "name",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "MY_ARTIFACTORY_PASSWORD",
      "description": "The name of the secret."
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "description": "Set secrets for Dependabot."
}

{
  "type": "object",
  "properties": {
    "scope": {
      "enum": [
        "runtime",
        "development"
      ],
      "type": "string",
      "example": "runtime",
      "description": "A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes."
    },
    "metadata": {
      "$ref": "#/components/schemas/metadata"
    },
    "package_url": {
      "type": "string",
      "example": "pkg:/npm/%40actions/http-client@1.0.11",
      "pattern": "^pkg",
      "description": "Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details."
    },
    "dependencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": "@actions/http-client",
      "description": "Array of package-url (PURLs) of direct child dependencies."
    },
    "relationship": {
      "enum": [
        "direct",
        "indirect"
      ],
      "type": "string",
      "example": "direct",
      "description": "A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency."
    }
  },
  "additionalProperties": false
}

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "change_type",
      "manifest",
      "ecosystem",
      "name",
      "version",
      "package_url",
      "license",
      "source_repository_url",
      "vulnerabilities",
      "scope"
    ],
    "properties": {
      "name": {
        "type": "string",
        "example": "@actions/core"
      },
      "scope": {
        "enum": [
          "unknown",
          "runtime",
          "development"
        ],
        "type": "string",
        "description": "Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment."
      },
      "license": {
        "type": "string",
        "example": "MIT",
        "nullable": true
      },
      "version": {
        "type": "string",
        "example": "1.0.0"
      },
      "manifest": {
        "type": "string",
        "example": "path/to/package-lock.json"
      },
      "ecosystem": {
        "type": "string",
        "example": "npm"
      },
      "change_type": {
        "enum": [
          "added",
          "removed"
        ],
        "type": "string"
      },
      "package_url": {
        "type": "string",
        "example": "pkg:/npm/%40actions/core@1.1.0",
        "nullable": true
      },
      "vulnerabilities": {
        "type": "array",
        "items": {
          "type": "object",
          "required": [
            "severity",
            "advisory_ghsa_id",
            "advisory_summary",
            "advisory_url"
          ],
          "properties": {
            "severity": {
              "type": "string",
              "example": "critical"
            },
            "advisory_url": {
              "type": "string",
              "example": "https://github.com/advisories/GHSA-rf4j-j272-fj86"
            },
            "advisory_ghsa_id": {
              "type": "string",
              "example": "GHSA-rf4j-j272-fj86"
            },
            "advisory_summary": {
              "type": "string",
              "example": "A summary of the advisory."
            }
          }
        }
      },
      "source_repository_url": {
        "type": "string",
        "example": "https://github.com/github/actions",
        "nullable": true
      }
    }
  },
  "title": "Dependency Graph Diff",
  "description": "A diff of the dependencies between two commits."
}

{
  "type": "object",
  "title": "Dependency Graph SPDX SBOM",
  "required": [
    "sbom"
  ],
  "properties": {
    "sbom": {
      "type": "object",
      "required": [
        "SPDXID",
        "spdxVersion",
        "creationInfo",
        "name",
        "dataLicense",
        "documentNamespace",
        "packages"
      ],
      "properties": {
        "name": {
          "type": "string",
          "example": "github/github",
          "description": "The name of the SPDX document."
        },
        "SPDXID": {
          "type": "string",
          "example": "SPDXRef-DOCUMENT",
          "description": "The SPDX identifier for the SPDX document."
        },
        "comment": {
          "type": "string",
          "example": "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/",
          "description": "An optional comment about the SPDX document."
        },
        "packages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string",
                "example": "github/github",
                "description": "The name of the package."
              },
              "SPDXID": {
                "type": "string",
                "example": "SPDXRef-Package",
                "description": "A unique SPDX identifier for the package."
              },
              "supplier": {
                "type": "string",
                "example": "NOASSERTION",
                "description": "The distribution source of this package, or NOASSERTION if this was not determined."
              },
              "versionInfo": {
                "type": "string",
                "example": "1.0.0",
                "description": "The version of the package. If the package does not have an exact version specified,\na version range is given."
              },
              "externalRefs": {
                "type": "array",
                "items": {
                  "type": "object",
                  "required": [
                    "referenceCategory",
                    "referenceLocator",
                    "referenceType"
                  ],
                  "properties": {
                    "referenceType": {
                      "type": "string",
                      "example": "purl",
                      "description": "The category of reference to an external resource this reference refers to."
                    },
                    "referenceLocator": {
                      "type": "string",
                      "example": "pkg:gem/rails@6.0.1",
                      "description": "A locator for the particular external resource this reference refers to."
                    },
                    "referenceCategory": {
                      "type": "string",
                      "example": "PACKAGE-MANAGER",
                      "description": "The category of reference to an external resource this reference refers to."
                    }
                  }
                }
              },
              "copyrightText": {
                "type": "string",
                "example": "Copyright (c) 1985 GitHub.com",
                "description": "The copyright holders of the package, and any dates present with those notices, if available."
              },
              "filesAnalyzed": {
                "type": "boolean",
                "example": false,
                "description": "Whether the package's file content has been subjected to\nanalysis during the creation of the SPDX document."
              },
              "licenseDeclared": {
                "type": "string",
                "example": "NOASSERTION",
                "description": "The license of the package as declared by its author, or NOASSERTION if this information\nwas not available when the SPDX document was created."
              },
              "downloadLocation": {
                "type": "string",
                "example": "NOASSERTION",
                "description": "The location where the package can be downloaded,\nor NOASSERTION if this has not been determined."
              },
              "licenseConcluded": {
                "type": "string",
                "example": "MIT",
                "description": "The license of the package as determined while creating the SPDX document."
              }
            }
          },
          "required": [
            "SPDXID",
            "name",
            "versionInfo",
            "downloadLocation",
            "filesAnalyzed"
          ]
        },
        "dataLicense": {
          "type": "string",
          "example": "CC0-1.0",
          "description": "The license under which the SPDX document is licensed."
        },
        "spdxVersion": {
          "type": "string",
          "example": "SPDX-2.3",
          "description": "The version of the SPDX specification that this document conforms to."
        },
        "creationInfo": {
          "type": "object",
          "required": [
            "created",
            "creators"
          ],
          "properties": {
            "created": {
              "type": "string",
              "example": "2021-11-03T00:00:00Z",
              "description": "The date and time the SPDX document was created."
            },
            "creators": {
              "type": "array",
              "items": {
                "type": "string",
                "example": "GitHub"
              },
              "description": "The tools that were used to generate the SPDX document."
            }
          }
        },
        "relationships": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "spdxElementId": {
                "type": "string",
                "description": "The SPDX identifier of the package that is the source of the relationship."
              },
              "relationshipType": {
                "type": "string",
                "example": "DEPENDS_ON",
                "description": "The type of relationship between the two SPDX elements."
              },
              "relatedSpdxElement": {
                "type": "string",
                "description": "The SPDX identifier of the package that is the target of the relationship."
              }
            }
          },
          "required": [
            "relationshipType",
            "spdxElementId",
            "relatedSpdxElement"
          ]
        },
        "documentNamespace": {
          "type": "string",
          "example": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57",
          "description": "The namespace for the SPDX document."
        }
      }
    }
  },
  "description": "A schema for the SPDX JSON format returned by the Dependency Graph."
}

{
  "type": "object",
  "title": "Deploy Key",
  "required": [
    "id",
    "key",
    "url",
    "title",
    "verified",
    "created_at",
    "read_only"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "key": {
      "type": "string"
    },
    "url": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "added_by": {
      "type": "string",
      "nullable": true
    },
    "verified": {
      "type": "boolean"
    },
    "last_used": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "read_only": {
      "type": "boolean"
    },
    "created_at": {
      "type": "string"
    }
  },
  "description": "An SSH key granting access to a single repository."
}

{
  "type": "object",
  "title": "Deployment",
  "required": [
    "id",
    "node_id",
    "sha",
    "ref",
    "task",
    "environment",
    "creator",
    "payload",
    "description",
    "statuses_url",
    "repository_url",
    "url",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 42,
      "description": "Unique identifier of the deployment"
    },
    "ref": {
      "type": "string",
      "example": "topic-branch",
      "description": "The ref to deploy. This can be a branch, tag, or sha."
    },
    "sha": {
      "type": "string",
      "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1"
    },
    "task": {
      "type": "string",
      "example": "deploy",
      "description": "Parameter to specify a task to execute"
    },
    "creator": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkRlcGxveW1lbnQx"
    },
    "payload": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "string"
        }
      ]
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "description": {
      "type": "string",
      "example": "Deploy request from hubot",
      "nullable": true
    },
    "environment": {
      "type": "string",
      "example": "production",
      "description": "Name for the target deployment environment."
    },
    "statuses_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
    },
    "repository_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example"
    },
    "original_environment": {
      "type": "string",
      "example": "staging"
    },
    "transient_environment": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false."
    },
    "production_environment": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if the given environment is one that end-users directly interact with. Default: false."
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "description": "A request for a specific ref(branch,sha,tag) to be deployed"
}

{
  "type": "object",
  "title": "Deployment branch policy",
  "properties": {
    "id": {
      "type": "integer",
      "example": 361471,
      "description": "The unique identifier of the branch or tag policy."
    },
    "name": {
      "type": "string",
      "example": "release/*",
      "description": "The name pattern that branches or tags must match in order to deploy to the environment."
    },
    "type": {
      "enum": [
        "branch",
        "tag"
      ],
      "type": "string",
      "example": "branch",
      "description": "Whether this rule targets a branch or tag."
    },
    "node_id": {
      "type": "string",
      "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
    }
  },
  "description": "Details of a deployment branch or tag policy."
}

{
  "type": "object",
  "title": "Deployment branch policy name pattern",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "release/*",
      "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch)."
    }
  }
}

{
  "type": "object",
  "title": "Deployment branch and tag policy name pattern",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "release/*",
      "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch)."
    },
    "type": {
      "enum": [
        "branch",
        "tag"
      ],
      "type": "string",
      "example": "branch",
      "description": "Whether this rule targets a branch or tag"
    }
  }
}

{
  "type": "object",
  "nullable": true,
  "required": [
    "protected_branches",
    "custom_branch_policies"
  ],
  "properties": {
    "protected_branches": {
      "type": "boolean",
      "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`."
    },
    "custom_branch_policies": {
      "type": "boolean",
      "description": "Whether only branches that match the specified name patterns can deploy to this environment.  If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`."
    }
  },
  "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`."
}

{
  "type": "object",
  "title": "Deployment protection rule",
  "required": [
    "id",
    "node_id",
    "enabled",
    "app"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 3515,
      "description": "The unique identifier for the deployment protection rule."
    },
    "app": {
      "$ref": "#/components/schemas/custom-deployment-rule-app"
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether the deployment protection rule is enabled for the environment."
    },
    "node_id": {
      "type": "string",
      "example": "MDQ6R2F0ZTM1MTU=",
      "description": "The node ID for the deployment protection rule."
    }
  },
  "description": "Deployment protection rule"
}

{
  "enum": [
    "User",
    "Team"
  ],
  "type": "string",
  "example": "User",
  "description": "The type of reviewer."
}

{
  "type": "object",
  "title": "Deployment",
  "required": [
    "id",
    "node_id",
    "task",
    "environment",
    "description",
    "statuses_url",
    "repository_url",
    "url",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "example": 42,
      "description": "Unique identifier of the deployment"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1"
    },
    "task": {
      "type": "string",
      "example": "deploy",
      "description": "Parameter to specify a task to execute"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOkRlcGxveW1lbnQx"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "description": {
      "type": "string",
      "example": "Deploy request from hubot",
      "nullable": true
    },
    "environment": {
      "type": "string",
      "example": "production",
      "description": "Name for the target deployment environment."
    },
    "statuses_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses"
    },
    "repository_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example"
    },
    "original_environment": {
      "type": "string",
      "example": "staging"
    },
    "transient_environment": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false."
    },
    "production_environment": {
      "type": "boolean",
      "example": true,
      "description": "Specifies if the given environment is one that end-users directly interact with. Default: false."
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "description": "A deployment created as the result of an Actions check run from a workflow that references an environment"
}

{
  "type": "object",
  "title": "Deployment Status",
  "required": [
    "id",
    "node_id",
    "state",
    "creator",
    "description",
    "deployment_url",
    "target_url",
    "repository_url",
    "url",
    "created_at",
    "updated_at"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "example": 1
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/42/statuses/1"
    },
    "state": {
      "enum": [
        "error",
        "failure",
        "inactive",
        "pending",
        "success",
        "queued",
        "in_progress"
      ],
      "type": "string",
      "example": "success",
      "description": "The state of the status."
    },
    "creator": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "log_url": {
      "type": "string",
      "format": "uri",
      "default": "",
      "example": "https://example.com/deployment/42/output",
      "description": "The URL to associate with this status."
    },
    "node_id": {
      "type": "string",
      "example": "MDE2OkRlcGxveW1lbnRTdGF0dXMx"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "target_url": {
      "type": "string",
      "format": "uri",
      "default": "",
      "example": "https://example.com/deployment/42/output",
      "description": "Closing down notice: the URL to associate with this status."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2012-07-20T01:19:13Z"
    },
    "description": {
      "type": "string",
      "default": "",
      "example": "Deployment finished successfully.",
      "maxLength": 140,
      "description": "A short description of the status."
    },
    "environment": {
      "type": "string",
      "default": "",
      "example": "production",
      "description": "The environment of the deployment that the status is for."
    },
    "deployment_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example/deployments/42"
    },
    "repository_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/example"
    },
    "environment_url": {
      "type": "string",
      "format": "uri",
      "default": "",
      "example": "https://staging.example.com/",
      "description": "The URL for accessing your environment."
    },
    "performed_via_github_app": {
      "$ref": "#/components/schemas/nullable-integration"
    }
  },
  "description": "The status of a deployment."
}

{
  "type": "object",
  "title": "Diff Entry",
  "required": [
    "additions",
    "blob_url",
    "changes",
    "contents_url",
    "deletions",
    "filename",
    "raw_url",
    "sha",
    "status"
  ],
  "properties": {
    "sha": {
      "type": "string",
      "example": "bbcd538c8e72b8c175046e27cc8f907076331401",
      "nullable": true
    },
    "patch": {
      "type": "string",
      "example": "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test"
    },
    "status": {
      "enum": [
        "added",
        "removed",
        "modified",
        "renamed",
        "copied",
        "changed",
        "unchanged"
      ],
      "type": "string",
      "example": "added"
    },
    "changes": {
      "type": "integer",
      "example": 124
    },
    "raw_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt"
    },
    "blob_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt"
    },
    "filename": {
      "type": "string",
      "example": "file1.txt"
    },
    "additions": {
      "type": "integer",
      "example": 103
    },
    "deletions": {
      "type": "integer",
      "example": 21
    },
    "contents_url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e"
    },
    "previous_filename": {
      "type": "string",
      "example": "file.txt"
    }
  },
  "description": "Diff Entry"
}

{
  "type": "object",
  "title": "Discussion",
  "required": [
    "repository_url",
    "category",
    "answer_html_url",
    "answer_chosen_at",
    "answer_chosen_by",
    "html_url",
    "id",
    "node_id",
    "number",
    "title",
    "user",
    "state",
    "state_reason",
    "locked",
    "comments",
    "created_at",
    "updated_at",
    "active_lock_reason",
    "body"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "body": {
      "type": "string"
    },
    "user": {
      "type": "object",
      "title": "User",
      "nullable": true,
      "required": [
        "login",
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "enum": [
            "Bot",
            "User",
            "Organization"
          ],
          "type": "string"
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "login": {
          "type": "string"
        },
        "deleted": {
          "type": "boolean"
        },
        "node_id": {
          "type": "string"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "gists_url": {
          "type": "string",
          "format": "uri-template"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "events_url": {
          "type": "string",
          "format": "uri-template"
        },
        "site_admin": {
          "type": "boolean"
        },
        "gravatar_id": {
          "type": "string"
        },
        "starred_url": {
          "type": "string",
          "format": "uri-template"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string",
          "format": "uri-template"
        },
        "user_view_type": {
          "type": "string"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "state": {
      "enum": [
        "open",
        "closed",
        "locked",
        "converting",
        "transferring"
      ],
      "type": "string",
      "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository."
    },
    "title": {
      "type": "string"
    },
    "labels": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/label"
      }
    },
    "locked": {
      "type": "boolean"
    },
    "number": {
      "type": "integer"
    },
    "node_id": {
      "type": "string"
    },
    "category": {
      "type": "object",
      "required": [
        "id",
        "repository_id",
        "emoji",
        "name",
        "description",
        "created_at",
        "updated_at",
        "slug",
        "is_answerable"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "type": "string"
        },
        "emoji": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "updated_at": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "is_answerable": {
          "type": "boolean"
        },
        "repository_id": {
          "type": "integer"
        }
      }
    },
    "comments": {
      "type": "integer"
    },
    "html_url": {
      "type": "string"
    },
    "reactions": {
      "type": "object",
      "title": "Reactions",
      "required": [
        "url",
        "total_count",
        "+1",
        "-1",
        "laugh",
        "confused",
        "heart",
        "hooray",
        "eyes",
        "rocket"
      ],
      "properties": {
        "+1": {
          "type": "integer"
        },
        "-1": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "eyes": {
          "type": "integer"
        },
        "heart": {
          "type": "integer"
        },
        "laugh": {
          "type": "integer"
        },
        "hooray": {
          "type": "integer"
        },
        "rocket": {
          "type": "integer"
        },
        "confused": {
          "type": "integer"
        },
        "total_count": {
          "type": "integer"
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "state_reason": {
      "enum": [
        "resolved",
        "outdated",
        "duplicate",
        "reopened"
      ],
      "type": "string",
      "example": "resolved",
      "nullable": true,
      "description": "The reason for the current state"
    },
    "timeline_url": {
      "type": "string"
    },
    "repository_url": {
      "type": "string"
    },
    "answer_html_url": {
      "type": "string",
      "nullable": true
    },
    "answer_chosen_at": {
      "type": "string",
      "nullable": true
    },
    "answer_chosen_by": {
      "type": "object",
      "title": "User",
      "nullable": true,
      "required": [
        "login",
        "id"
      ],
      "properties": {
        "id": {
          "type": "integer"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "enum": [
            "Bot",
            "User",
            "Organization"
          ],
          "type": "string"
        },
        "email": {
          "type": "string",
          "nullable": true
        },
        "login": {
          "type": "string"
        },
        "deleted": {
          "type": "boolean"
        },
        "node_id": {
          "type": "string"
        },
        "html_url": {
          "type": "string",
          "format": "uri"
        },
        "gists_url": {
          "type": "string",
          "format": "uri-template"
        },
        "repos_url": {
          "type": "string",
          "format": "uri"
        },
        "avatar_url": {
          "type": "string",
          "format": "uri"
        },
        "events_url": {
          "type": "string",
          "format": "uri-template"
        },
        "site_admin": {
          "type": "boolean"
        },
        "gravatar_id": {
          "type": "string"
        },
        "starred_url": {
          "type": "string",
          "format": "uri-template"
        },
        "followers_url": {
          "type": "string",
          "format": "uri"
        },
        "following_url": {
          "type": "string",
          "format": "uri-template"
        },
        "user_view_type": {
          "type": "string"
        },
        "organizations_url": {
          "type": "string",
          "format": "uri"
        },
        "subscriptions_url": {
          "type": "string",
          "format": "uri"
        },
        "received_events_url": {
          "type": "string",
          "format": "uri"
        }
      }
    },
    "active_lock_reason": {
      "type": "string",
      "nullable": true
    },
    "author_association": {
      "enum": [
        "COLLABORATOR",
        "CONTRIBUTOR",
        "FIRST_TIMER",
        "FIRST_TIME_CONTRIBUTOR",
        "MANNEQUIN",
        "MEMBER",
        "NONE",
        "OWNER"
      ],
      "type": "string",
      "title": "AuthorAssociation",
      "description": "How the author is associated with the repository."
    }
  },
  "description": "A Discussion in a repository."
}

{
  "type": "object",
  "title": "DiscussionEvent",
  "required": [
    "action",
    "discussion"
  ],
  "properties": {
    "action": {
      "type": "string"
    },
    "discussion": {
      "$ref": "#/components/schemas/discussion"
    }
  }
}