actions/languageservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
5dbaa884dbd889a68eb184eb0f28c0f6618264ee
languageservices/languageservice/src/context-providers/events/objects.json
T
Josh Gross e2a4389fcf Deduplicate objects in webhook payloads
2023-03-13 11:02:01 -04:00

26220 lines
651 KiB
JSON
Raw Blame History

[
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"created"
]
},
{
"type": "object",
"name": "enterprise",
"in": "body",
"description": "An enterprise on GitHub.",
"childParamsGroups": [
{
"type": "string or null",
"name": "description",
"description": "A short description of the enterprise."
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string or null",
"name": "website_url",
"description": "The enterprise's website URL."
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the enterprise",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the enterprise.",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug url identifier for the enterprise.",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
}
]
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "The ID of the installation.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"description": "The global node ID of the installation.",
"isRequired": true
}
]
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "A GitHub organization.",
"childParamsGroups": [
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "public_members_url",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
}
]
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "A repository on GitHub.",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"description": "License Simple",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
},
{
"type": "string or null",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "html_url"
}
]
},
{
"type": "object or null",
"name": "organization",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
}
]
},
{
"type": "object",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "integer",
"name": "size",
"description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template",
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"default": false
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"default": false
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository disabled.",
"isRequired": true
},
{
"type": "string",
"name": "visibility",
"description": "The repository visibility: public, private, or internal.",
"default": "public"
},
{
"type": "string or null",
"name": "pushed_at",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "object or null",
"name": "template_repository",
"childParamsGroups": [
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "full_name"
},
{
"type": "object",
"name": "owner",
"childParamsGroups": [
{
"type": "string",
"name": "login"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "avatar_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "type"
},
{
"type": "boolean",
"name": "site_admin"
}
]
},
{
"type": "boolean",
"name": "private"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "description"
},
{
"type": "boolean",
"name": "fork"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "archive_url"
},
{
"type": "string",
"name": "assignees_url"
},
{
"type": "string",
"name": "blobs_url"
},
{
"type": "string",
"name": "branches_url"
},
{
"type": "string",
"name": "collaborators_url"
},
{
"type": "string",
"name": "comments_url"
},
{
"type": "string",
"name": "commits_url"
},
{
"type": "string",
"name": "compare_url"
},
{
"type": "string",
"name": "contents_url"
},
{
"type": "string",
"name": "contributors_url"
},
{
"type": "string",
"name": "deployments_url"
},
{
"type": "string",
"name": "downloads_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "forks_url"
},
{
"type": "string",
"name": "git_commits_url"
},
{
"type": "string",
"name": "git_refs_url"
},
{
"type": "string",
"name": "git_tags_url"
},
{
"type": "string",
"name": "git_url"
},
{
"type": "string",
"name": "issue_comment_url"
},
{
"type": "string",
"name": "issue_events_url"
},
{
"type": "string",
"name": "issues_url"
},
{
"type": "string",
"name": "keys_url"
},
{
"type": "string",
"name": "labels_url"
},
{
"type": "string",
"name": "languages_url"
},
{
"type": "string",
"name": "merges_url"
},
{
"type": "string",
"name": "milestones_url"
},
{
"type": "string",
"name": "notifications_url"
},
{
"type": "string",
"name": "pulls_url"
},
{
"type": "string",
"name": "releases_url"
},
{
"type": "string",
"name": "ssh_url"
},
{
"type": "string",
"name": "stargazers_url"
},
{
"type": "string",
"name": "statuses_url"
},
{
"type": "string",
"name": "subscribers_url"
},
{
"type": "string",
"name": "subscription_url"
},
{
"type": "string",
"name": "tags_url"
},
{
"type": "string",
"name": "teams_url"
},
{
"type": "string",
"name": "trees_url"
},
{
"type": "string",
"name": "clone_url"
},
{
"type": "string",
"name": "mirror_url"
},
{
"type": "string",
"name": "hooks_url"
},
{
"type": "string",
"name": "svn_url"
},
{
"type": "string",
"name": "homepage"
},
{
"type": "string",
"name": "language"
},
{
"type": "integer",
"name": "forks_count"
},
{
"type": "integer",
"name": "stargazers_count"
},
{
"type": "integer",
"name": "watchers_count"
},
{
"type": "integer",
"name": "size"
},
{
"type": "string",
"name": "default_branch"
},
{
"type": "integer",
"name": "open_issues_count"
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues"
},
{
"type": "boolean",
"name": "has_projects"
},
{
"type": "boolean",
"name": "has_wiki"
},
{
"type": "boolean",
"name": "has_pages"
},
{
"type": "boolean",
"name": "has_downloads"
},
{
"type": "boolean",
"name": "archived"
},
{
"type": "boolean",
"name": "disabled"
},
{
"type": "string",
"name": "visibility"
},
{
"type": "string",
"name": "pushed_at"
},
{
"type": "string",
"name": "created_at"
},
{
"type": "string",
"name": "updated_at"
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin"
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "push"
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "pull"
}
]
},
{
"type": "boolean",
"name": "allow_rebase_merge"
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge"
},
{
"type": "boolean",
"name": "allow_auto_merge"
},
{
"type": "boolean",
"name": "delete_branch_on_merge"
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default"
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit"
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
}
]
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow Auto-merge to be used on pull requests.",
"default": false
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "boolean",
"name": "allow_update_branch",
"description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
"default": false
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow forking this repo"
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits",
"default": false
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "starred_at"
},
{
"type": "boolean",
"name": "anonymous_access_enabled",
"description": "Whether anonymous git access is enabled for this repository"
}
]
},
{
"type": "object",
"name": "rule",
"in": "body",
"description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings.",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "admin_enforced",
"isRequired": true
},
{
"type": "string",
"name": "allow_deletions_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "string",
"name": "allow_force_pushes_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "array of strings",
"name": "authorized_actor_names",
"isRequired": true
},
{
"type": "boolean",
"name": "authorized_actors_only",
"isRequired": true
},
{
"type": "boolean",
"name": "authorized_dismissal_actors_only",
"isRequired": true
},
{
"type": "boolean",
"name": "create_protected"
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "boolean",
"name": "dismiss_stale_reviews_on_push",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "boolean",
"name": "ignore_approvals_from_contributors",
"isRequired": true
},
{
"type": "string",
"name": "linear_history_requirement_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "string",
"name": "merge_queue_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "pull_request_reviews_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "integer",
"name": "repository_id",
"isRequired": true
},
{
"type": "boolean",
"name": "require_code_owner_review",
"isRequired": true
},
{
"type": "integer",
"name": "required_approving_review_count",
"isRequired": true
},
{
"type": "string",
"name": "required_conversation_resolution_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "string",
"name": "required_deployments_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "array of strings",
"name": "required_status_checks",
"isRequired": true
},
{
"type": "string",
"name": "required_status_checks_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "string",
"name": "signature_requirement_enforcement_level",
"isRequired": true,
"enum": [
"off",
"non_admins",
"everyone"
]
},
{
"type": "boolean",
"name": "strict_required_status_checks_policy",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
}
]
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"deleted"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"edited"
]
},
{
"type": "object",
"name": "check_run",
"in": "body",
"description": "A check performed on the code of a given code change",
"isRequired": true,
"childParamsGroups": [
{
"type": "object or null",
"name": "app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "issues"
},
{
"type": "string",
"name": "checks"
},
{
"type": "string",
"name": "metadata"
},
{
"type": "string",
"name": "contents"
},
{
"type": "string",
"name": "deployments"
}
]
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app",
"isRequired": true
},
{
"type": "integer",
"name": "installations_count",
"description": "The number of installations associated with the GitHub app"
},
{
"type": "string",
"name": "client_id"
},
{
"type": "string",
"name": "client_secret"
},
{
"type": "string or null",
"name": "webhook_secret"
},
{
"type": "string",
"name": "pem"
}
]
},
{
"type": "object",
"name": "check_suite",
"description": "A suite of checks performed on the code of a given code change",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "after"
},
{
"type": "object",
"name": "app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "issues"
},
{
"type": "string",
"name": "checks"
},
{
"type": "string",
"name": "metadata"
},
{
"type": "string",
"name": "contents"
},
{
"type": "string",
"name": "deployments"
}
]
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app",
"isRequired": true
},
{
"type": "integer",
"name": "installations_count",
"description": "The number of installations associated with the GitHub app"
},
{
"type": "string",
"name": "client_id"
},
{
"type": "string",
"name": "client_secret"
},
{
"type": "string or null",
"name": "webhook_secret"
},
{
"type": "string",
"name": "pem"
}
]
},
{
"type": "string or null",
"name": "before"
},
{
"type": "string or null",
"name": "conclusion",
"enum": [
"success",
"failure",
"neutral",
"cancelled",
"skipped",
"timed_out",
"action_required",
"stale",
"startup_failure"
]
},
{
"type": "string",
"name": "created_at"
},
{
"type": "string or null",
"name": "head_branch"
},
{
"type": "string",
"name": "head_sha",
"description": "The SHA of the head commit that is being checked."
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "array of objects",
"name": "pull_requests",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object",
"name": "head",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "base",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
}
]
}
]
},
{
"type": "object",
"name": "repository",
"description": "Minimal Repository",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "object",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "boolean",
"name": "private",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string",
"name": "ssh_url"
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url"
},
{
"type": "string or null",
"name": "mirror_url"
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url"
},
{
"type": "string or null",
"name": "homepage"
},
{
"type": "string or null",
"name": "language"
},
{
"type": "integer",
"name": "forks_count"
},
{
"type": "integer",
"name": "stargazers_count"
},
{
"type": "integer",
"name": "watchers_count"
},
{
"type": "integer",
"name": "size",
"description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0."
},
{
"type": "string",
"name": "default_branch"
},
{
"type": "integer",
"name": "open_issues_count"
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues"
},
{
"type": "boolean",
"name": "has_projects"
},
{
"type": "boolean",
"name": "has_wiki"
},
{
"type": "boolean",
"name": "has_pages"
},
{
"type": "boolean",
"name": "has_downloads"
},
{
"type": "boolean",
"name": "has_discussions"
},
{
"type": "boolean",
"name": "archived"
},
{
"type": "boolean",
"name": "disabled"
},
{
"type": "string",
"name": "visibility"
},
{
"type": "string or null",
"name": "pushed_at"
},
{
"type": "string or null",
"name": "created_at"
},
{
"type": "string or null",
"name": "updated_at"
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin"
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "push"
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "pull"
}
]
},
{
"type": "string",
"name": "role_name"
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "delete_branch_on_merge"
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
},
{
"type": "object",
"name": "code_of_conduct",
"description": "Code Of Conduct",
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "body"
},
{
"type": "string or null",
"name": "html_url",
"isRequired": true
}
]
},
{
"type": "object or null",
"name": "license",
"childParamsGroups": [
{
"type": "string",
"name": "key"
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "spdx_id"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "node_id"
}
]
},
{
"type": "integer",
"name": "forks"
},
{
"type": "integer",
"name": "open_issues"
},
{
"type": "integer",
"name": "watchers"
},
{
"type": "boolean",
"name": "allow_forking"
},
{
"type": "boolean",
"name": "web_commit_signoff_required"
},
{
"type": "object or null",
"name": "security_and_analysis",
"childParamsGroups": [
{
"type": "object",
"name": "advanced_security",
"childParamsGroups": [
{
"type": "string",
"name": "status",
"enum": [
"enabled",
"disabled"
]
}
]
},
{
"type": "object",
"name": "secret_scanning",
"childParamsGroups": [
{
"type": "string",
"name": "status",
"enum": [
"enabled",
"disabled"
]
}
]
},
{
"type": "object",
"name": "secret_scanning_push_protection",
"childParamsGroups": [
{
"type": "string",
"name": "status",
"enum": [
"enabled",
"disabled"
]
}
]
}
]
}
]
},
{
"type": "string",
"name": "status",
"enum": [
"queued",
"in_progress",
"completed",
"pending",
"waiting"
]
},
{
"type": "string",
"name": "updated_at"
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "completed_at",
"isRequired": true
},
{
"type": "string or null",
"name": "conclusion",
"isRequired": true,
"enum": [
"waiting",
"pending",
"startup_failure",
"stale",
"success",
"failure",
"neutral",
"cancelled",
"skipped",
"timed_out",
"action_required"
]
},
{
"type": "object",
"name": "deployment",
"description": "A deployment created as the result of an Actions check run from a workflow that references an environment",
"childParamsGroups": [
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the deployment",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "task",
"description": "Parameter to specify a task to execute",
"isRequired": true
},
{
"type": "string",
"name": "original_environment"
},
{
"type": "string",
"name": "environment",
"description": "Name for the target deployment environment.",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "boolean",
"name": "transient_environment",
"description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false."
},
{
"type": "boolean",
"name": "production_environment",
"description": "Specifies if the given environment is one that end-users directly interact with. Default: false."
},
{
"type": "object or null",
"name": "performed_via_github_app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "issues"
},
{
"type": "string",
"name": "checks"
},
{
"type": "string",
"name": "metadata"
},
{
"type": "string",
"name": "contents"
},
{
"type": "string",
"name": "deployments"
}
]
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app",
"isRequired": true
},
{
"type": "integer",
"name": "installations_count",
"description": "The number of installations associated with the GitHub app"
},
{
"type": "string",
"name": "client_id"
},
{
"type": "string",
"name": "client_secret"
},
{
"type": "string or null",
"name": "webhook_secret"
},
{
"type": "string",
"name": "pem"
}
]
}
]
},
{
"type": "string",
"name": "details_url",
"isRequired": true
},
{
"type": "string",
"name": "external_id",
"isRequired": true
},
{
"type": "string",
"name": "head_sha",
"description": "The SHA of the commit that is being checked.",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "The id of the check.",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the check.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object",
"name": "output",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "annotations_count",
"isRequired": true
},
{
"type": "string",
"name": "annotations_url",
"isRequired": true
},
{
"type": "string or null",
"name": "summary",
"isRequired": true
},
{
"type": "string or null",
"name": "text",
"isRequired": true
},
{
"type": "string or null",
"name": "title",
"isRequired": true
}
]
},
{
"type": "array of objects",
"name": "pull_requests",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object",
"name": "head",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "base",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
}
]
}
]
},
{
"type": "string",
"name": "started_at",
"isRequired": true
},
{
"type": "string",
"name": "status",
"description": "The phase of the lifecycle that the check is currently in.",
"isRequired": true,
"enum": [
"queued",
"in_progress",
"completed",
"pending"
]
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"enum": [
"created"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"completed"
]
},
{
"type": "object or null",
"name": "actions_meta",
"in": "body"
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"requested"
]
},
{
"type": "string",
"name": "commit_oid",
"in": "body",
"description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"in": "body",
"description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty.",
"isRequired": true
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"fixed"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"reopened"
]
},
{
"type": "string",
"name": "pusher_type",
"in": "body",
"description": "The pusher type for the event. Can be either `user` or a deploy key.",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"in": "body",
"description": "The [`git ref`](https://docs.github.com/rest/reference/git#get-a-reference) resource.",
"isRequired": true
},
{
"type": "object",
"name": "alert",
"in": "body",
"description": "A Dependabot alert.",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "number",
"description": "The security alert number.",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the Dependabot alert.",
"isRequired": true,
"enum": [
"dismissed",
"fixed",
"open"
]
},
{
"type": "object",
"name": "dependency",
"description": "Details for the vulnerable dependency.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "package",
"description": "Details for the vulnerable package.",
"childParamsGroups": [
{
"type": "string",
"name": "ecosystem",
"description": "The package's language or package management ecosystem.",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The unique package name within its ecosystem.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "manifest_path",
"description": "The full path to the dependency manifest file, relative to the root of the repository."
},
{
"type": "string or null",
"name": "scope",
"description": "The execution scope of the vulnerable dependency.",
"enum": [
"development",
"runtime"
]
}
]
},
{
"type": "object",
"name": "security_advisory",
"description": "Details for the GitHub Security Advisory.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ghsa_id",
"description": "The unique GitHub Security Advisory ID assigned to the advisory.",
"isRequired": true
},
{
"type": "string or null",
"name": "cve_id",
"description": "The unique CVE ID assigned to the advisory.",
"isRequired": true
},
{
"type": "string",
"name": "summary",
"description": "A short, plain text summary of the advisory.",
"isRequired": true
},
{
"type": "string",
"name": "description",
"description": "A long-form Markdown-supported description of the advisory.",
"isRequired": true
},
{
"type": "array of objects",
"name": "vulnerabilities",
"description": "Vulnerable version range information for the advisory.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "package",
"description": "Details for the vulnerable package.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ecosystem",
"description": "The package's language or package management ecosystem.",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The unique package name within its ecosystem.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "severity",
"description": "The severity of the vulnerability.",
"isRequired": true,
"enum": [
"low",
"medium",
"high",
"critical"
]
},
{
"type": "string",
"name": "vulnerable_version_range",
"description": "Conditions that identify vulnerable versions of this vulnerability's package.",
"isRequired": true
},
{
"type": "object or null",
"name": "first_patched_version",
"description": "Details pertaining to the package version that patches this vulnerability.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "identifier",
"description": "The package version that patches this vulnerability.",
"isRequired": true
}
]
}
]
},
{
"type": "string",
"name": "severity",
"description": "The severity of the advisory.",
"isRequired": true,
"enum": [
"low",
"medium",
"high",
"critical"
]
},
{
"type": "object",
"name": "cvss",
"description": "Details for the advisory pertaining to the Common Vulnerability Scoring System.",
"isRequired": true,
"childParamsGroups": [
{
"type": "number",
"name": "score",
"description": "The overall CVSS score of the advisory.",
"isRequired": true
},
{
"type": "string or null",
"name": "vector_string",
"description": "The full CVSS vector string for the advisory.",
"isRequired": true
}
]
},
{
"type": "array of objects",
"name": "cwes",
"description": "Details for the advisory pertaining to Common Weakness Enumeration.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "cwe_id",
"description": "The unique CWE ID.",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The short, plain text name of the CWE.",
"isRequired": true
}
]
},
{
"type": "array of objects",
"name": "identifiers",
"description": "Values that identify this advisory among security information sources.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "type",
"description": "The type of advisory identifier.",
"isRequired": true,
"enum": [
"CVE",
"GHSA"
]
},
{
"type": "string",
"name": "value",
"description": "The value of the advisory identifer.",
"isRequired": true
}
]
},
{
"type": "array of objects",
"name": "references",
"description": "Links to additional advisory information.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "url",
"description": "The URL of the reference.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "published_at",
"description": "The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"description": "The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
},
{
"type": "string or null",
"name": "withdrawn_at",
"description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
}
]
},
{
"type": "object",
"name": "security_vulnerability",
"description": "Details pertaining to one vulnerable version range for the advisory.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "package",
"description": "Details for the vulnerable package.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ecosystem",
"description": "The package's language or package management ecosystem.",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The unique package name within its ecosystem.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "severity",
"description": "The severity of the vulnerability.",
"isRequired": true,
"enum": [
"low",
"medium",
"high",
"critical"
]
},
{
"type": "string",
"name": "vulnerable_version_range",
"description": "Conditions that identify vulnerable versions of this vulnerability's package.",
"isRequired": true
},
{
"type": "object or null",
"name": "first_patched_version",
"description": "Details pertaining to the package version that patches this vulnerability.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "identifier",
"description": "The package version that patches this vulnerability.",
"isRequired": true
}
]
}
]
},
{
"type": "string",
"name": "url",
"description": "The REST API URL of the alert resource.",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"description": "The GitHub URL of the alert resource.",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
},
{
"type": "string or null",
"name": "dismissed_at",
"description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
},
{
"type": "object or null",
"name": "dismissed_by",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string or null",
"name": "dismissed_reason",
"description": "The reason that the alert was dismissed.",
"isRequired": true,
"enum": [
"fix_started",
"inaccurate",
"no_bandwidth",
"not_used",
"tolerable_risk"
]
},
{
"type": "string or null",
"name": "dismissed_comment",
"description": "An optional comment associated with the alert's dismissal.",
"isRequired": true
},
{
"type": "string or null",
"name": "fixed_at",
"description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"dismissed"
]
},
{
"type": "object",
"name": "key",
"in": "body",
"description": "The [`deploy key`](https://docs.github.com/rest/reference/deployments#get-a-deploy-key) resource.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "added_by"
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string or null",
"name": "last_used"
},
{
"type": "boolean",
"name": "read_only",
"isRequired": true
},
{
"type": "string",
"name": "title",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "verified",
"isRequired": true
}
]
},
{
"type": "object or null",
"name": "workflow",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "badge_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "path",
"isRequired": true
},
{
"type": "string",
"name": "state",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "object",
"name": "discussion",
"in": "body",
"description": "A Discussion in a repository.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true
},
{
"type": "string or null",
"name": "answer_chosen_at",
"isRequired": true
},
{
"type": "object or null",
"name": "answer_chosen_by",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "answer_html_url",
"isRequired": true
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string",
"name": "body",
"isRequired": true
},
{
"type": "object",
"name": "category",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "emoji",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "boolean",
"name": "is_answerable",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "integer",
"name": "repository_id",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
}
]
},
{
"type": "integer",
"name": "comments",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "boolean",
"name": "locked",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "object",
"name": "reactions",
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"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.",
"isRequired": true,
"enum": [
"open",
"locked",
"converting",
"transferring"
]
},
{
"type": "string",
"name": "timeline_url"
},
{
"type": "string",
"name": "title",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"labeled"
]
},
{
"type": "object",
"name": "label",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"locked"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"pinned"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"transferred"
]
},
{
"type": "object",
"name": "sender",
"in": "body",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"unlabeled"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"unlocked"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"unpinned"
]
},
{
"type": "object",
"name": "comment",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string",
"name": "body",
"isRequired": true
},
{
"type": "integer",
"name": "child_comment_count",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "discussion_id",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer or null",
"name": "parent_id",
"isRequired": true
},
{
"type": "object",
"name": "reactions",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"revoked"
]
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "A repository on GitHub.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"description": "License Simple",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
},
{
"type": "string or null",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "html_url"
}
]
},
{
"type": "object or null",
"name": "organization",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
}
]
},
{
"type": "object",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "integer",
"name": "size",
"description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template",
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"default": false
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"default": false
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository disabled.",
"isRequired": true
},
{
"type": "string",
"name": "visibility",
"description": "The repository visibility: public, private, or internal.",
"default": "public"
},
{
"type": "string or null",
"name": "pushed_at",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "object or null",
"name": "template_repository",
"childParamsGroups": [
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "full_name"
},
{
"type": "object",
"name": "owner",
"childParamsGroups": [
{
"type": "string",
"name": "login"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "avatar_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "type"
},
{
"type": "boolean",
"name": "site_admin"
}
]
},
{
"type": "boolean",
"name": "private"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "description"
},
{
"type": "boolean",
"name": "fork"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "archive_url"
},
{
"type": "string",
"name": "assignees_url"
},
{
"type": "string",
"name": "blobs_url"
},
{
"type": "string",
"name": "branches_url"
},
{
"type": "string",
"name": "collaborators_url"
},
{
"type": "string",
"name": "comments_url"
},
{
"type": "string",
"name": "commits_url"
},
{
"type": "string",
"name": "compare_url"
},
{
"type": "string",
"name": "contents_url"
},
{
"type": "string",
"name": "contributors_url"
},
{
"type": "string",
"name": "deployments_url"
},
{
"type": "string",
"name": "downloads_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "forks_url"
},
{
"type": "string",
"name": "git_commits_url"
},
{
"type": "string",
"name": "git_refs_url"
},
{
"type": "string",
"name": "git_tags_url"
},
{
"type": "string",
"name": "git_url"
},
{
"type": "string",
"name": "issue_comment_url"
},
{
"type": "string",
"name": "issue_events_url"
},
{
"type": "string",
"name": "issues_url"
},
{
"type": "string",
"name": "keys_url"
},
{
"type": "string",
"name": "labels_url"
},
{
"type": "string",
"name": "languages_url"
},
{
"type": "string",
"name": "merges_url"
},
{
"type": "string",
"name": "milestones_url"
},
{
"type": "string",
"name": "notifications_url"
},
{
"type": "string",
"name": "pulls_url"
},
{
"type": "string",
"name": "releases_url"
},
{
"type": "string",
"name": "ssh_url"
},
{
"type": "string",
"name": "stargazers_url"
},
{
"type": "string",
"name": "statuses_url"
},
{
"type": "string",
"name": "subscribers_url"
},
{
"type": "string",
"name": "subscription_url"
},
{
"type": "string",
"name": "tags_url"
},
{
"type": "string",
"name": "teams_url"
},
{
"type": "string",
"name": "trees_url"
},
{
"type": "string",
"name": "clone_url"
},
{
"type": "string",
"name": "mirror_url"
},
{
"type": "string",
"name": "hooks_url"
},
{
"type": "string",
"name": "svn_url"
},
{
"type": "string",
"name": "homepage"
},
{
"type": "string",
"name": "language"
},
{
"type": "integer",
"name": "forks_count"
},
{
"type": "integer",
"name": "stargazers_count"
},
{
"type": "integer",
"name": "watchers_count"
},
{
"type": "integer",
"name": "size"
},
{
"type": "string",
"name": "default_branch"
},
{
"type": "integer",
"name": "open_issues_count"
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues"
},
{
"type": "boolean",
"name": "has_projects"
},
{
"type": "boolean",
"name": "has_wiki"
},
{
"type": "boolean",
"name": "has_pages"
},
{
"type": "boolean",
"name": "has_downloads"
},
{
"type": "boolean",
"name": "archived"
},
{
"type": "boolean",
"name": "disabled"
},
{
"type": "string",
"name": "visibility"
},
{
"type": "string",
"name": "pushed_at"
},
{
"type": "string",
"name": "created_at"
},
{
"type": "string",
"name": "updated_at"
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin"
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "push"
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "pull"
}
]
},
{
"type": "boolean",
"name": "allow_rebase_merge"
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge"
},
{
"type": "boolean",
"name": "allow_auto_merge"
},
{
"type": "boolean",
"name": "delete_branch_on_merge"
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default"
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit"
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
}
]
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow Auto-merge to be used on pull requests.",
"default": false
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "boolean",
"name": "allow_update_branch",
"description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
"default": false
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow forking this repo"
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits",
"default": false
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "starred_at"
},
{
"type": "boolean",
"name": "anonymous_access_enabled",
"description": "Whether anonymous git access is enabled for this repository"
}
]
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "Installation",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "The ID of the installation.",
"isRequired": true
},
{
"type": "null",
"name": "account",
"isRequired": true
},
{
"type": "string",
"name": "repository_selection",
"description": "Describe whether all repositories have been selected or there's a selection involved",
"isRequired": true,
"enum": [
"all",
"selected"
]
},
{
"type": "string",
"name": "access_tokens_url",
"isRequired": true
},
{
"type": "string",
"name": "repositories_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "app_id",
"isRequired": true
},
{
"type": "integer",
"name": "target_id",
"description": "The ID of the user or organization this token is being scoped to.",
"isRequired": true
},
{
"type": "string",
"name": "target_type",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The permissions granted to the user-to-server access token.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "actions",
"description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "administration",
"description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "checks",
"description": "The level of permission to grant the access token for checks on code.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "contents",
"description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "deployments",
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "environments",
"description": "The level of permission to grant the access token for managing repository environments.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "issues",
"description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "metadata",
"description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "packages",
"description": "The level of permission to grant the access token for packages published to GitHub Packages.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pages",
"description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pull_requests",
"description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_announcement_banners",
"description": "The level of permission to grant the access token to view and manage announcement banners for a repository.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_hooks",
"description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_projects",
"description": "The level of permission to grant the access token to manage repository projects, columns, and cards.",
"enum": [
"read",
"write",
"admin"
]
},
{
"type": "string",
"name": "secret_scanning_alerts",
"description": "The level of permission to grant the access token to view and manage secret scanning alerts.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "secrets",
"description": "The level of permission to grant the access token to manage repository secrets.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "security_events",
"description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "single_file",
"description": "The level of permission to grant the access token to manage just a single file.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "statuses",
"description": "The level of permission to grant the access token for commit statuses.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "vulnerability_alerts",
"description": "The level of permission to grant the access token to manage Dependabot alerts.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "workflows",
"description": "The level of permission to grant the access token to update GitHub Actions workflow files.",
"enum": [
"write"
]
},
{
"type": "string",
"name": "members",
"description": "The level of permission to grant the access token for organization teams and members.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_administration",
"description": "The level of permission to grant the access token to manage access to an organization.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_custom_roles",
"description": "The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_announcement_banners",
"description": "The level of permission to grant the access token to view and manage announcement banners for an organization.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_hooks",
"description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_plan",
"description": "The level of permission to grant the access token for viewing an organization's plan.",
"enum": [
"read"
]
},
{
"type": "string",
"name": "organization_projects",
"description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).",
"enum": [
"read",
"write",
"admin"
]
},
{
"type": "string",
"name": "organization_packages",
"description": "The level of permission to grant the access token for organization packages published to GitHub Packages.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_secrets",
"description": "The level of permission to grant the access token to manage organization secrets.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_self_hosted_runners",
"description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_user_blocking",
"description": "The level of permission to grant the access token to view and manage users blocked by the organization.",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "team_discussions",
"description": "The level of permission to grant the access token to manage team discussions and related comments.",
"enum": [
"read",
"write"
]
}
]
},
{
"type": "array of strings",
"name": "events",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string or null",
"name": "single_file_name",
"isRequired": true
},
{
"type": "boolean",
"name": "has_multiple_single_files"
},
{
"type": "array of strings",
"name": "single_file_paths"
},
{
"type": "string",
"name": "app_slug",
"isRequired": true
},
{
"type": "object or null",
"name": "suspended_by",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string or null",
"name": "suspended_at",
"isRequired": true
},
{
"type": "string or null",
"name": "contact_email"
}
]
},
{
"type": "array of objects",
"name": "repositories",
"in": "body",
"description": "An array of repository objects that the installation can access.",
"childParamsGroups": [
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
}
]
},
{
"type": "null",
"name": "requester",
"in": "body"
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"added"
]
},
{
"type": "array of objects",
"name": "repositories_added",
"in": "body",
"description": "An array of repository objects, which were added to the installation.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
}
]
},
{
"type": "string",
"name": "repository_selection",
"in": "body",
"description": "Describe whether all repositories have been selected or there's a selection involved",
"isRequired": true,
"enum": [
"all",
"selected"
]
},
{
"type": "object or null",
"name": "requester",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"removed"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true
},
{
"type": "object",
"name": "installation",
"in": "body",
"description": "The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "The ID of the installation.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"description": "The global node ID of the installation.",
"isRequired": true
}
]
},
{
"type": "object",
"name": "comment",
"in": "body",
"description": "The [comment](https://docs.github.com/rest/reference/issues#comments) itself.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string",
"name": "body",
"description": "Contents of the issue comment",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the issue comment",
"isRequired": true
},
{
"type": "string",
"name": "issue_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "performed_via_github_app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "issues"
},
{
"type": "string",
"name": "checks"
},
{
"type": "string",
"name": "metadata"
},
{
"type": "string",
"name": "contents"
},
{
"type": "string",
"name": "deployments"
}
]
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app",
"isRequired": true
},
{
"type": "integer",
"name": "installations_count",
"description": "The number of installations associated with the GitHub app"
},
{
"type": "string",
"name": "client_id"
},
{
"type": "string",
"name": "client_secret"
},
{
"type": "string or null",
"name": "webhook_secret"
},
{
"type": "string",
"name": "pem"
}
]
},
{
"type": "object",
"name": "reactions",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the issue comment",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "changes",
"in": "body",
"description": "The changes to the comment.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "body",
"childParamsGroups": [
{
"type": "string",
"name": "from",
"description": "The previous version of the body.",
"isRequired": true
}
]
}
]
},
{
"type": "object",
"name": "issue",
"in": "body",
"description": "The [issue](https://docs.github.com/rest/reference/issues) itself.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
{
"type": "object or null",
"name": "assignee",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "array of objects",
"name": "assignees",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string or null",
"name": "body",
"description": "Contents of the issue",
"isRequired": true
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "comments",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "boolean",
"name": "draft"
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "array of objects",
"name": "labels",
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "boolean",
"name": "locked"
},
{
"type": "object or null",
"name": "milestone",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "object or null",
"name": "performed_via_github_app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"childParamsGroups": [
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app"
},
{
"type": "string or null",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer or null",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"childParamsGroups": [
{
"type": "string",
"name": "actions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "administration",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "checks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "content_references",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "contents",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "deployments",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "discussions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "emails",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "environments",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "issues",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "keys",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "members",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "metadata",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_administration",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_hooks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_packages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_plan",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_projects",
"enum": [
"read",
"write",
"admin"
]
},
{
"type": "string",
"name": "organization_secrets",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_self_hosted_runners",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_user_blocking",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "packages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pull_requests",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_hooks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_projects",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "secret_scanning_alerts",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "secrets",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "security_events",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "security_scanning_alert",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "single_file",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "statuses",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "team_discussions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "vulnerability_alerts",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "workflows",
"enum": [
"read",
"write"
]
}
]
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
}
]
},
{
"type": "object",
"name": "pull_request",
"childParamsGroups": [
{
"type": "string",
"name": "diff_url"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string or null",
"name": "merged_at"
},
{
"type": "string",
"name": "patch_url"
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "reactions",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of the issue; either 'open' or 'closed'",
"enum": [
"open",
"closed"
]
},
{
"type": "string or null",
"name": "state_reason"
},
{
"type": "string",
"name": "timeline_url"
},
{
"type": "string",
"name": "title",
"description": "Title of the issue",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the issue",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "issue",
"in": "body",
"description": "The [issue](https://docs.github.com/rest/reference/issues) itself.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
{
"type": "object or null",
"name": "assignee",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "array of objects",
"name": "assignees",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string or null",
"name": "body",
"description": "Contents of the issue",
"isRequired": true
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "comments",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "boolean",
"name": "draft"
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "array of objects",
"name": "labels",
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "boolean",
"name": "locked"
},
{
"type": "object or null",
"name": "milestone",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "object or null",
"name": "performed_via_github_app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"childParamsGroups": [
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app"
},
{
"type": "string or null",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer or null",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"childParamsGroups": [
{
"type": "string",
"name": "actions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "administration",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "checks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "content_references",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "contents",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "deployments",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "discussions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "emails",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "environments",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "issues",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "keys",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "members",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "metadata",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_administration",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_hooks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_packages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_plan",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_projects",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_secrets",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_self_hosted_runners",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "organization_user_blocking",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "packages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pages",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "pull_requests",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_hooks",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "repository_projects",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "secret_scanning_alerts",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "secrets",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "security_events",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "security_scanning_alert",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "single_file",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "statuses",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "team_discussions",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "vulnerability_alerts",
"enum": [
"read",
"write"
]
},
{
"type": "string",
"name": "workflows",
"enum": [
"read",
"write"
]
}
]
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
}
]
},
{
"type": "object",
"name": "pull_request",
"childParamsGroups": [
{
"type": "string",
"name": "diff_url"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string or null",
"name": "merged_at"
},
{
"type": "string",
"name": "patch_url"
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "reactions",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of the issue; either 'open' or 'closed'",
"enum": [
"open",
"closed"
]
},
{
"type": "string or null",
"name": "state_reason"
},
{
"type": "string",
"name": "timeline_url"
},
{
"type": "string",
"name": "title",
"description": "Title of the issue",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the issue",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"demilestoned"
]
},
{
"type": "object",
"name": "label",
"in": "body",
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"milestoned"
]
},
{
"type": "object",
"name": "milestone",
"in": "body",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"opened"
]
},
{
"type": "object or null",
"name": "assignee",
"in": "body",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"cancelled"
]
},
{
"type": "string",
"name": "effective_date",
"in": "body",
"isRequired": true
},
{
"type": "object",
"name": "marketplace_purchase",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "account",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string or null",
"name": "organization_billing_email",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
}
]
},
{
"type": "string",
"name": "billing_cycle",
"isRequired": true
},
{
"type": "string or null",
"name": "free_trial_ends_on",
"isRequired": true
},
{
"type": "string or null",
"name": "next_billing_date"
},
{
"type": "boolean",
"name": "on_free_trial",
"isRequired": true
},
{
"type": "object",
"name": "plan",
"isRequired": true,
"childParamsGroups": [
{
"type": "array of strings",
"name": "bullets",
"isRequired": true
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "has_free_trial",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_cents",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "price_model",
"isRequired": true,
"enum": [
"FREE",
"FLAT_RATE",
"PER_UNIT"
]
},
{
"type": "string or null",
"name": "unit_name",
"isRequired": true
},
{
"type": "integer",
"name": "yearly_price_in_cents",
"isRequired": true
}
]
},
{
"type": "integer",
"name": "unit_count",
"isRequired": true
},
{
"type": "object",
"name": "account",
"childParamsGroups": [
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "login"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string or null",
"name": "organization_billing_email"
},
{
"type": "string",
"name": "type"
}
]
},
{
"type": "string",
"name": "billing_cycle"
},
{
"type": "string or null",
"name": "free_trial_ends_on"
},
{
"type": "string or null",
"name": "next_billing_date",
"isRequired": true
},
{
"type": "boolean",
"name": "on_free_trial"
},
{
"type": "object",
"name": "plan",
"childParamsGroups": [
{
"type": "array of strings",
"name": "bullets"
},
{
"type": "string",
"name": "description"
},
{
"type": "boolean",
"name": "has_free_trial"
},
{
"type": "integer",
"name": "id"
},
{
"type": "integer",
"name": "monthly_price_in_cents"
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "price_model",
"enum": [
"FREE",
"FLAT_RATE",
"PER_UNIT"
]
},
{
"type": "string or null",
"name": "unit_name"
},
{
"type": "integer",
"name": "yearly_price_in_cents"
}
]
},
{
"type": "integer",
"name": "unit_count"
}
]
},
{
"type": "object",
"name": "previous_marketplace_purchase",
"in": "body",
"childParamsGroups": [
{
"type": "object",
"name": "account",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string or null",
"name": "organization_billing_email",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
}
]
},
{
"type": "string",
"name": "billing_cycle",
"isRequired": true
},
{
"type": "null",
"name": "free_trial_ends_on",
"isRequired": true
},
{
"type": "string or null",
"name": "next_billing_date"
},
{
"type": "boolean",
"name": "on_free_trial",
"isRequired": true
},
{
"type": "object",
"name": "plan",
"isRequired": true,
"childParamsGroups": [
{
"type": "array of strings",
"name": "bullets",
"isRequired": true
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "has_free_trial",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_cents",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "price_model",
"isRequired": true,
"enum": [
"FREE",
"FLAT_RATE",
"PER_UNIT"
]
},
{
"type": "string or null",
"name": "unit_name",
"isRequired": true
},
{
"type": "integer",
"name": "yearly_price_in_cents",
"isRequired": true
}
]
},
{
"type": "integer",
"name": "unit_count",
"isRequired": true
}
]
},
{
"type": "object or null",
"name": "member",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "organization",
"in": "body",
"description": "A GitHub organization.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "public_members_url",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
}
]
},
{
"type": "object or null",
"name": "sender",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "team",
"in": "body",
"description": "Groups of organization members that gives permissions on specified repositories.",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "description",
"description": "Description of the team"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url"
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "object or null",
"name": "parent",
"childParamsGroups": [
{
"type": "string or null",
"name": "description",
"description": "Description of the team",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories",
"isRequired": true
},
{
"type": "string",
"name": "privacy",
"isRequired": true,
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the team",
"isRequired": true
}
]
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories"
},
{
"type": "string",
"name": "privacy",
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url"
},
{
"type": "string",
"name": "slug"
},
{
"type": "string",
"name": "url",
"description": "URL for the team"
}
]
},
{
"type": "object or null",
"name": "repository",
"in": "body",
"description": "A repository on GitHub.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"description": "License Simple",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
},
{
"type": "string or null",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "html_url"
}
]
},
{
"type": "object or null",
"name": "organization",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
}
]
},
{
"type": "object",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "integer",
"name": "size",
"description": "The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template",
"description": "Whether this repository acts as a template that can be used to generate new repositories.",
"default": false
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"default": false
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository disabled.",
"isRequired": true
},
{
"type": "string",
"name": "visibility",
"description": "The repository visibility: public, private, or internal.",
"default": "public"
},
{
"type": "string or null",
"name": "pushed_at",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string or null",
"name": "updated_at",
"isRequired": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "object or null",
"name": "template_repository",
"childParamsGroups": [
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "full_name"
},
{
"type": "object",
"name": "owner",
"childParamsGroups": [
{
"type": "string",
"name": "login"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "avatar_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "type"
},
{
"type": "boolean",
"name": "site_admin"
}
]
},
{
"type": "boolean",
"name": "private"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "string",
"name": "description"
},
{
"type": "boolean",
"name": "fork"
},
{
"type": "string",
"name": "url"
},
{
"type": "string",
"name": "archive_url"
},
{
"type": "string",
"name": "assignees_url"
},
{
"type": "string",
"name": "blobs_url"
},
{
"type": "string",
"name": "branches_url"
},
{
"type": "string",
"name": "collaborators_url"
},
{
"type": "string",
"name": "comments_url"
},
{
"type": "string",
"name": "commits_url"
},
{
"type": "string",
"name": "compare_url"
},
{
"type": "string",
"name": "contents_url"
},
{
"type": "string",
"name": "contributors_url"
},
{
"type": "string",
"name": "deployments_url"
},
{
"type": "string",
"name": "downloads_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "forks_url"
},
{
"type": "string",
"name": "git_commits_url"
},
{
"type": "string",
"name": "git_refs_url"
},
{
"type": "string",
"name": "git_tags_url"
},
{
"type": "string",
"name": "git_url"
},
{
"type": "string",
"name": "issue_comment_url"
},
{
"type": "string",
"name": "issue_events_url"
},
{
"type": "string",
"name": "issues_url"
},
{
"type": "string",
"name": "keys_url"
},
{
"type": "string",
"name": "labels_url"
},
{
"type": "string",
"name": "languages_url"
},
{
"type": "string",
"name": "merges_url"
},
{
"type": "string",
"name": "milestones_url"
},
{
"type": "string",
"name": "notifications_url"
},
{
"type": "string",
"name": "pulls_url"
},
{
"type": "string",
"name": "releases_url"
},
{
"type": "string",
"name": "ssh_url"
},
{
"type": "string",
"name": "stargazers_url"
},
{
"type": "string",
"name": "statuses_url"
},
{
"type": "string",
"name": "subscribers_url"
},
{
"type": "string",
"name": "subscription_url"
},
{
"type": "string",
"name": "tags_url"
},
{
"type": "string",
"name": "teams_url"
},
{
"type": "string",
"name": "trees_url"
},
{
"type": "string",
"name": "clone_url"
},
{
"type": "string",
"name": "mirror_url"
},
{
"type": "string",
"name": "hooks_url"
},
{
"type": "string",
"name": "svn_url"
},
{
"type": "string",
"name": "homepage"
},
{
"type": "string",
"name": "language"
},
{
"type": "integer",
"name": "forks_count"
},
{
"type": "integer",
"name": "stargazers_count"
},
{
"type": "integer",
"name": "watchers_count"
},
{
"type": "integer",
"name": "size"
},
{
"type": "string",
"name": "default_branch"
},
{
"type": "integer",
"name": "open_issues_count"
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "array of strings",
"name": "topics"
},
{
"type": "boolean",
"name": "has_issues"
},
{
"type": "boolean",
"name": "has_projects"
},
{
"type": "boolean",
"name": "has_wiki"
},
{
"type": "boolean",
"name": "has_pages"
},
{
"type": "boolean",
"name": "has_downloads"
},
{
"type": "boolean",
"name": "archived"
},
{
"type": "boolean",
"name": "disabled"
},
{
"type": "string",
"name": "visibility"
},
{
"type": "string",
"name": "pushed_at"
},
{
"type": "string",
"name": "created_at"
},
{
"type": "string",
"name": "updated_at"
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin"
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "push"
},
{
"type": "boolean",
"name": "triage"
},
{
"type": "boolean",
"name": "pull"
}
]
},
{
"type": "boolean",
"name": "allow_rebase_merge"
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge"
},
{
"type": "boolean",
"name": "allow_auto_merge"
},
{
"type": "boolean",
"name": "delete_branch_on_merge"
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default"
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit"
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
}
]
},
{
"type": "string",
"name": "temp_clone_token"
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow Auto-merge to be used on pull requests.",
"default": false
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "boolean",
"name": "allow_update_branch",
"description": "Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.",
"default": false
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow forking this repo"
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits",
"default": false
},
{
"type": "integer",
"name": "subscribers_count"
},
{
"type": "integer",
"name": "network_count"
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "starred_at"
},
{
"type": "boolean",
"name": "anonymous_access_enabled",
"description": "Whether anonymous git access is enabled for this repository"
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"closed"
]
},
{
"type": "object",
"name": "milestone",
"in": "body",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "object or null",
"name": "blocked_user",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "membership",
"in": "body",
"description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
"childParamsGroups": [
{
"type": "string",
"name": "organization_url",
"isRequired": true
},
{
"type": "string",
"name": "role",
"isRequired": true
},
{
"type": "string",
"name": "state",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "membership",
"in": "body",
"description": "The membership between the user and the organization. Not present when the action is `member_invited`.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "organization_url",
"isRequired": true
},
{
"type": "string",
"name": "role",
"isRequired": true
},
{
"type": "string",
"name": "state",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"renamed"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"published"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"updated"
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"converted"
]
},
{
"type": "object",
"name": "project_card",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer or null",
"name": "after_id"
},
{
"type": "boolean",
"name": "archived",
"description": "Whether or not the card is archived",
"isRequired": true
},
{
"type": "integer",
"name": "column_id",
"isRequired": true
},
{
"type": "string",
"name": "column_url",
"isRequired": true
},
{
"type": "string",
"name": "content_url"
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "integer",
"name": "id",
"description": "The project card's ID",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string or null",
"name": "note",
"isRequired": true
},
{
"type": "string",
"name": "project_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"moved"
]
},
{
"type": "object",
"name": "project",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "body",
"description": "Body of the project",
"isRequired": true
},
{
"type": "string",
"name": "columns_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the project",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "string",
"name": "owner_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of the project; either 'open' or 'closed'",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "object",
"name": "project_column",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer or null",
"name": "after_id"
},
{
"type": "string",
"name": "cards_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "The unique identifier of the project column",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the project column",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "project_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "object",
"name": "projects_v2",
"in": "body",
"description": "A projects v2 project",
"isRequired": true,
"childParamsGroups": [
{
"type": "number",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "object",
"name": "creator",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "title",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "public",
"isRequired": true
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "string or null",
"name": "short_description",
"isRequired": true
},
{
"type": "string or null",
"name": "deleted_at",
"isRequired": true
},
{
"type": "object or null",
"name": "deleted_by",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"archived"
]
},
{
"type": "object",
"name": "changes",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "archived_at",
"childParamsGroups": [
{
"type": "string or null",
"name": "from"
},
{
"type": "string or null",
"name": "to"
}
]
}
]
},
{
"type": "object",
"name": "projects_v2_item",
"in": "body",
"description": "An item belonging to a project",
"isRequired": true,
"childParamsGroups": [
{
"type": "number",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "project_node_id"
},
{
"type": "string",
"name": "content_node_id",
"isRequired": true
},
{
"type": "string",
"name": "content_type",
"description": "The type of content tracked in a project item",
"isRequired": true,
"enum": [
"Issue",
"PullRequest",
"DraftIssue"
]
},
{
"type": "object",
"name": "creator",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string or null",
"name": "archived_at",
"isRequired": true
}
]
},
{
"type": "integer",
"name": "number",
"in": "body",
"description": "The pull request number.",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"in": "body",
"isRequired": true
},
{
"type": "string",
"name": "reason",
"in": "body",
"isRequired": true
},
{
"type": "object",
"name": "pull_request",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "_links",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "commits",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "html",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "issue",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comment",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "self",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "statuses",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
}
]
},
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
{
"type": "integer",
"name": "additions"
},
{
"type": "object or null",
"name": "assignee",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "array of objects",
"name": "assignees",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "object or null",
"name": "auto_merge",
"description": "The status of auto merging a pull request.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "commit_message",
"description": "Commit message for the merge commit.",
"isRequired": true
},
{
"type": "string or null",
"name": "commit_title",
"description": "Title for the merge commit message.",
"isRequired": true
},
{
"type": "object or null",
"name": "enabled_by",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "merge_method",
"description": "The merge method to use.",
"isRequired": true,
"enum": [
"merge",
"squash",
"rebase"
]
}
]
},
{
"type": "object",
"name": "base",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string or null",
"name": "body",
"isRequired": true
},
{
"type": "integer",
"name": "changed_files"
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "comments"
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "integer",
"name": "commits"
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "deletions"
},
{
"type": "string",
"name": "diff_url",
"isRequired": true
},
{
"type": "boolean",
"name": "draft",
"description": "Indicates whether or not the pull request is a draft.",
"isRequired": true
},
{
"type": "object",
"name": "head",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "issue_url",
"isRequired": true
},
{
"type": "array of objects",
"name": "labels",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "boolean",
"name": "locked",
"isRequired": true
},
{
"type": "boolean",
"name": "maintainer_can_modify",
"description": "Indicates whether maintainers can modify the pull request."
},
{
"type": "string or null",
"name": "merge_commit_sha",
"isRequired": true
},
{
"type": "boolean or null",
"name": "mergeable"
},
{
"type": "string",
"name": "mergeable_state"
},
{
"type": "boolean or null",
"name": "merged"
},
{
"type": "string or null",
"name": "merged_at",
"isRequired": true
},
{
"type": "object or null",
"name": "merged_by",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object or null",
"name": "milestone",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "Number uniquely identifying the pull request within its repository.",
"isRequired": true
},
{
"type": "string",
"name": "patch_url",
"isRequired": true
},
{
"type": "boolean or null",
"name": "rebaseable"
},
{
"type": "array",
"name": "requested_reviewers",
"isRequired": true
},
{
"type": "array of objects",
"name": "requested_teams",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "description",
"description": "Description of the team"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url"
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "object or null",
"name": "parent",
"childParamsGroups": [
{
"type": "string or null",
"name": "description",
"description": "Description of the team",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories",
"isRequired": true
},
{
"type": "string",
"name": "privacy",
"isRequired": true,
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the team",
"isRequired": true
}
]
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories"
},
{
"type": "string",
"name": "privacy",
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url"
},
{
"type": "string",
"name": "slug"
},
{
"type": "string",
"name": "url",
"description": "URL for the team"
}
]
},
{
"type": "string",
"name": "review_comment_url",
"isRequired": true
},
{
"type": "integer",
"name": "review_comments"
},
{
"type": "string",
"name": "review_comments_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of this Pull Request. Either `open` or `closed`.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "title",
"description": "The title of the pull request.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "milestone",
"in": "body",
"description": "A collection of related issues and pull requests.",
"childParamsGroups": [
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
],
"default": "open"
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
}
]
},
{
"type": "object",
"name": "pull_request",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "_links",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "commits",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "html",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "issue",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comment",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "self",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "statuses",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
}
]
},
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
{
"type": "integer",
"name": "additions"
},
{
"type": "object or null",
"name": "assignee",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "array of objects",
"name": "assignees",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "object or null",
"name": "auto_merge",
"description": "The status of auto merging a pull request.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "commit_message",
"description": "Commit message for the merge commit.",
"isRequired": true
},
{
"type": "string or null",
"name": "commit_title",
"description": "Title for the merge commit message.",
"isRequired": true
},
{
"type": "object or null",
"name": "enabled_by",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "merge_method",
"description": "The merge method to use.",
"isRequired": true,
"enum": [
"merge",
"squash",
"rebase"
]
}
]
},
{
"type": "object",
"name": "base",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string or null",
"name": "body",
"isRequired": true
},
{
"type": "integer",
"name": "changed_files"
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "comments"
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "integer",
"name": "commits"
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "deletions"
},
{
"type": "string",
"name": "diff_url",
"isRequired": true
},
{
"type": "boolean",
"name": "draft",
"description": "Indicates whether or not the pull request is a draft.",
"isRequired": true
},
{
"type": "object",
"name": "head",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "issue_url",
"isRequired": true
},
{
"type": "array of objects",
"name": "labels",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "boolean",
"name": "locked",
"isRequired": true
},
{
"type": "boolean",
"name": "maintainer_can_modify",
"description": "Indicates whether maintainers can modify the pull request."
},
{
"type": "string or null",
"name": "merge_commit_sha",
"isRequired": true
},
{
"type": "boolean or null",
"name": "mergeable"
},
{
"type": "string",
"name": "mergeable_state"
},
{
"type": "boolean or null",
"name": "merged"
},
{
"type": "string or null",
"name": "merged_at",
"isRequired": true
},
{
"type": "object or null",
"name": "merged_by",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object or null",
"name": "milestone",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "Number uniquely identifying the pull request within its repository.",
"isRequired": true
},
{
"type": "string",
"name": "patch_url",
"isRequired": true
},
{
"type": "boolean or null",
"name": "rebaseable"
},
{
"type": "array",
"name": "requested_reviewers",
"isRequired": true
},
{
"type": "array of objects",
"name": "requested_teams",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "description",
"description": "Description of the team"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url"
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "object or null",
"name": "parent",
"childParamsGroups": [
{
"type": "string or null",
"name": "description",
"description": "Description of the team",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories",
"isRequired": true
},
{
"type": "string",
"name": "privacy",
"isRequired": true,
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the team",
"isRequired": true
}
]
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories"
},
{
"type": "string",
"name": "privacy",
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url"
},
{
"type": "string",
"name": "slug"
},
{
"type": "string",
"name": "url",
"description": "URL for the team"
}
]
},
{
"type": "string",
"name": "review_comment_url",
"isRequired": true
},
{
"type": "integer",
"name": "review_comments"
},
{
"type": "string",
"name": "review_comments_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of this Pull Request. Either `open` or `closed`.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "title",
"description": "The title of the pull request.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "pull_request",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "_links",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "commits",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "html",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "issue",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comment",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "review_comments",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "self",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "statuses",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
}
]
},
{
"type": "string or null",
"name": "active_lock_reason",
"isRequired": true,
"enum": [
"resolved",
"off-topic",
"too heated",
"spam",
null
]
},
{
"type": "integer",
"name": "additions"
},
{
"type": "object or null",
"name": "assignee",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "array of objects",
"name": "assignees",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "object or null",
"name": "auto_merge",
"description": "The status of auto merging a pull request.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "commit_message",
"description": "Commit message for the merge commit.",
"isRequired": true
},
{
"type": "string or null",
"name": "commit_title",
"description": "Title for the merge commit message.",
"isRequired": true
},
{
"type": "object or null",
"name": "enabled_by",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "merge_method",
"description": "The merge method to use.",
"isRequired": true,
"enum": [
"merge",
"squash",
"rebase"
]
}
]
},
{
"type": "object",
"name": "base",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string or null",
"name": "body",
"isRequired": true
},
{
"type": "integer",
"name": "changed_files"
},
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "comments"
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "integer",
"name": "commits"
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "deletions"
},
{
"type": "string",
"name": "diff_url",
"isRequired": true
},
{
"type": "boolean",
"name": "draft",
"description": "Indicates whether or not the pull request is a draft.",
"isRequired": true
},
{
"type": "object",
"name": "head",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"isRequired": true
},
{
"type": "object or null",
"name": "repo",
"description": "A git repository",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_discussions",
"description": "Whether discussions are enabled.",
"isRequired": true,
"default": false
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merge_commit_message",
"description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"PR_TITLE",
"BLANK"
]
},
{
"type": "string",
"name": "merge_commit_title",
"description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).",
"enum": [
"PR_TITLE",
"MERGE_MESSAGE"
]
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "squash_merge_commit_message",
"description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.",
"enum": [
"PR_BODY",
"COMMIT_MESSAGES",
"BLANK"
]
},
{
"type": "string",
"name": "squash_merge_commit_title",
"description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).",
"enum": [
"PR_TITLE",
"COMMIT_OR_PR_TITLE"
]
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "boolean",
"name": "use_squash_pr_title_as_default",
"description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
"default": false
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
},
{
"type": "boolean",
"name": "web_commit_signoff_required",
"description": "Whether to require contributors to sign off on web-based commits"
}
]
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "issue_url",
"isRequired": true
},
{
"type": "array of objects",
"name": "labels",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "color",
"description": "6-character hex code, without the leading #, identifying the color",
"isRequired": true
},
{
"type": "boolean",
"name": "default",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the label.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the label",
"isRequired": true
}
]
},
{
"type": "boolean",
"name": "locked",
"isRequired": true
},
{
"type": "boolean",
"name": "maintainer_can_modify",
"description": "Indicates whether maintainers can modify the pull request."
},
{
"type": "string or null",
"name": "merge_commit_sha",
"isRequired": true
},
{
"type": "boolean or null",
"name": "mergeable"
},
{
"type": "string",
"name": "mergeable_state"
},
{
"type": "boolean or null",
"name": "merged"
},
{
"type": "string or null",
"name": "merged_at",
"isRequired": true
},
{
"type": "object or null",
"name": "merged_by",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object or null",
"name": "milestone",
"description": "A collection of related issues and pull requests.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "closed_at",
"isRequired": true
},
{
"type": "integer",
"name": "closed_issues",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string or null",
"name": "due_on",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "The number of the milestone.",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "The state of the milestone.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "title",
"description": "The title of the milestone.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"description": "Number uniquely identifying the pull request within its repository.",
"isRequired": true
},
{
"type": "string",
"name": "patch_url",
"isRequired": true
},
{
"type": "boolean or null",
"name": "rebaseable"
},
{
"type": "array",
"name": "requested_reviewers",
"isRequired": true
},
{
"type": "array of objects",
"name": "requested_teams",
"isRequired": true,
"childParamsGroups": [
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "description",
"description": "Description of the team"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url"
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id"
},
{
"type": "object or null",
"name": "parent",
"childParamsGroups": [
{
"type": "string or null",
"name": "description",
"description": "Description of the team",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the team",
"isRequired": true
},
{
"type": "string",
"name": "members_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "Name of the team",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories",
"isRequired": true
},
{
"type": "string",
"name": "privacy",
"isRequired": true,
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the team",
"isRequired": true
}
]
},
{
"type": "string",
"name": "permission",
"description": "Permission that the team will have for its repositories"
},
{
"type": "string",
"name": "privacy",
"enum": [
"open",
"closed",
"secret"
]
},
{
"type": "string",
"name": "repositories_url"
},
{
"type": "string",
"name": "slug"
},
{
"type": "string",
"name": "url",
"description": "URL for the team"
}
]
},
{
"type": "string",
"name": "review_comment_url",
"isRequired": true
},
{
"type": "integer",
"name": "review_comments"
},
{
"type": "string",
"name": "review_comments_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of this Pull Request. Either `open` or `closed`.",
"isRequired": true,
"enum": [
"open",
"closed"
]
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "title",
"description": "The title of the pull request.",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization",
"Mannequin"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "comment",
"in": "body",
"description": "The [comment](https://docs.github.com/rest/reference/pulls#comments) itself.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "_links",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "html",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "pull_request",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "self",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string",
"name": "body",
"description": "The text of the comment.",
"isRequired": true
},
{
"type": "string",
"name": "commit_id",
"description": "The SHA of the commit to which the comment applies.",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "diff_hunk",
"description": "The diff of the line that the comment refers to.",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"description": "HTML URL for the pull request review comment.",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "The ID of the pull request review comment.",
"isRequired": true
},
{
"type": "integer",
"name": "in_reply_to_id",
"description": "The comment ID to reply to."
},
{
"type": "integer or null",
"name": "line",
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"description": "The node ID of the pull request review comment.",
"isRequired": true
},
{
"type": "string",
"name": "original_commit_id",
"description": "The SHA of the original commit to which the comment applies.",
"isRequired": true
},
{
"type": "integer",
"name": "original_line",
"description": "The line of the blob to which the comment applies. The last line of the range for a multi-line comment",
"isRequired": true
},
{
"type": "integer",
"name": "original_position",
"description": "The index of the original line in the diff to which the comment applies.",
"isRequired": true
},
{
"type": "integer or null",
"name": "original_start_line",
"description": "The first line of the range for a multi-line comment.",
"isRequired": true
},
{
"type": "string",
"name": "path",
"description": "The relative path of the file to which the comment applies.",
"isRequired": true
},
{
"type": "integer or null",
"name": "position",
"description": "The line index in the diff to which the comment applies.",
"isRequired": true
},
{
"type": "integer or null",
"name": "pull_request_review_id",
"description": "The ID of the pull request review to which the comment belongs.",
"isRequired": true
},
{
"type": "string",
"name": "pull_request_url",
"description": "URL for the pull request that the review comment belongs to.",
"isRequired": true
},
{
"type": "object",
"name": "reactions",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "side",
"description": "The side of the first line of the range for a multi-line comment.",
"isRequired": true,
"enum": [
"LEFT",
"RIGHT"
]
},
{
"type": "integer or null",
"name": "start_line",
"description": "The first line of the range for a multi-line comment.",
"isRequired": true
},
{
"type": "string or null",
"name": "start_side",
"description": "The side of the first line of the range for a multi-line comment.",
"isRequired": true,
"enum": [
"LEFT",
"RIGHT",
null
],
"default": "RIGHT"
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"description": "URL for the pull request review comment",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "object",
"name": "review",
"in": "body",
"description": "The review that was affected.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "_links",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "html",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
},
{
"type": "object",
"name": "pull_request",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "href",
"isRequired": true
}
]
}
]
},
{
"type": "string",
"name": "author_association",
"description": "How the author is associated with the repository.",
"isRequired": true,
"enum": [
"COLLABORATOR",
"CONTRIBUTOR",
"FIRST_TIMER",
"FIRST_TIME_CONTRIBUTOR",
"MANNEQUIN",
"MEMBER",
"NONE",
"OWNER"
]
},
{
"type": "string or null",
"name": "body",
"description": "The text of the review.",
"isRequired": true
},
{
"type": "string",
"name": "commit_id",
"description": "A commit SHA for the review.",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the review",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "pull_request_url",
"isRequired": true
},
{
"type": "string",
"name": "state",
"isRequired": true
},
{
"type": "string or null",
"name": "submitted_at",
"isRequired": true
},
{
"type": "object or null",
"name": "user",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"resolved"
]
},
{
"type": "object",
"name": "release",
"in": "body",
"description": "The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object.",
"isRequired": true,
"childParamsGroups": [
{
"type": "array of objects",
"name": "assets",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "browser_download_url",
"isRequired": true
},
{
"type": "string",
"name": "content_type",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "download_count",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string or null",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The file name of the asset.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of the release asset.",
"isRequired": true,
"enum": [
"uploaded"
]
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object or null",
"name": "uploader",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "assets_url",
"isRequired": true
},
{
"type": "object or null",
"name": "author",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "body",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "discussion_url"
},
{
"type": "boolean",
"name": "draft",
"description": "Whether the release is a draft or published",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string or null",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "boolean",
"name": "prerelease",
"description": "Whether the release is identified as a prerelease or a full release.",
"isRequired": true
},
{
"type": "string or null",
"name": "published_at",
"isRequired": true
},
{
"type": "object",
"name": "reactions",
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "tag_name",
"description": "The name of the tag.",
"isRequired": true
},
{
"type": "string or null",
"name": "tarball_url",
"isRequired": true
},
{
"type": "string",
"name": "target_commitish",
"description": "Specifies the commitish value that determines where the Git tag is created from.",
"isRequired": true
},
{
"type": "string",
"name": "upload_url",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string or null",
"name": "zipball_url",
"isRequired": true
}
]
},
{
"type": "object",
"name": "release",
"in": "body",
"description": "The [release](https://docs.github.com/rest/reference/repos/#get-a-release) object.",
"isRequired": true,
"childParamsGroups": [
{
"type": "array of objects",
"name": "assets",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "browser_download_url",
"isRequired": true
},
{
"type": "string",
"name": "content_type",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "integer",
"name": "download_count",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string or null",
"name": "label",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The file name of the asset.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "state",
"description": "State of the release asset.",
"isRequired": true,
"enum": [
"uploaded"
]
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object or null",
"name": "uploader",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "assets_url",
"isRequired": true
},
{
"type": "object or null",
"name": "author",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "body",
"isRequired": true
},
{
"type": "string or null",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "discussion_url"
},
{
"type": "boolean",
"name": "draft",
"description": "Whether the release is a draft or published",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string or null",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "boolean",
"name": "prerelease",
"description": "Whether the release is identified as a prerelease or a full release.",
"isRequired": true
},
{
"type": "string or null",
"name": "published_at",
"isRequired": true
},
{
"type": "object",
"name": "reactions",
"childParamsGroups": [
{
"type": "integer",
"name": "+1",
"isRequired": true
},
{
"type": "integer",
"name": "-1",
"isRequired": true
},
{
"type": "integer",
"name": "confused",
"isRequired": true
},
{
"type": "integer",
"name": "eyes",
"isRequired": true
},
{
"type": "integer",
"name": "heart",
"isRequired": true
},
{
"type": "integer",
"name": "hooray",
"isRequired": true
},
{
"type": "integer",
"name": "laugh",
"isRequired": true
},
{
"type": "integer",
"name": "rocket",
"isRequired": true
},
{
"type": "integer",
"name": "total_count",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "tag_name",
"description": "The name of the tag.",
"isRequired": true
},
{
"type": "string or null",
"name": "tarball_url",
"isRequired": true
},
{
"type": "string",
"name": "target_commitish",
"description": "Specifies the commitish value that determines where the Git tag is created from.",
"isRequired": true
},
{
"type": "string",
"name": "upload_url",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string or null",
"name": "zipball_url",
"isRequired": true
},
{
"type": "array of objects",
"name": "assets"
},
{
"type": "string",
"name": "assets_url"
},
{
"type": "object",
"name": "author",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "login"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type"
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string or null",
"name": "body"
},
{
"type": "string",
"name": "created_at"
},
{
"type": "boolean",
"name": "draft"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string or null",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "boolean",
"name": "prerelease"
},
{
"type": "string or null",
"name": "published_at",
"isRequired": true
},
{
"type": "string",
"name": "tag_name"
},
{
"type": "string or null",
"name": "tarball_url"
},
{
"type": "string",
"name": "target_commitish"
},
{
"type": "string",
"name": "upload_url"
},
{
"type": "string",
"name": "url"
},
{
"type": "string or null",
"name": "zipball_url"
}
]
},
{
"type": "object",
"name": "alert",
"in": "body",
"description": "The security alert of the vulnerable dependency.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "affected_package_name",
"isRequired": true
},
{
"type": "string",
"name": "affected_range",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "dismiss_reason"
},
{
"type": "string",
"name": "dismissed_at"
},
{
"type": "object or null",
"name": "dismisser",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "external_identifier",
"isRequired": true
},
{
"type": "string or null",
"name": "external_reference",
"isRequired": true
},
{
"type": "string",
"name": "fix_reason"
},
{
"type": "string",
"name": "fixed_at"
},
{
"type": "string",
"name": "fixed_in"
},
{
"type": "string",
"name": "ghsa_id",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "integer",
"name": "number",
"isRequired": true
},
{
"type": "string",
"name": "severity",
"isRequired": true
},
{
"type": "string",
"name": "state",
"isRequired": true,
"enum": [
"open",
"dismissed",
"fixed"
]
},
{
"type": "string",
"name": "affected_package_name"
},
{
"type": "string",
"name": "affected_range"
},
{
"type": "string",
"name": "created_at"
},
{
"type": "string",
"name": "external_identifier"
},
{
"type": "string or null",
"name": "external_reference"
},
{
"type": "string",
"name": "fixed_in"
},
{
"type": "string",
"name": "ghsa_id"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "integer",
"name": "number"
},
{
"type": "string",
"name": "severity"
},
{
"type": "string",
"name": "state",
"isRequired": true,
"enum": [
"open"
]
}
]
},
{
"type": "object",
"name": "alert",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "integer",
"name": "number",
"description": "The security alert number."
},
{
"type": "string",
"name": "created_at",
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
{
"type": "string or null",
"name": "updated_at",
"description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
{
"type": "string",
"name": "url",
"description": "The REST API URL of the alert resource."
},
{
"type": "string",
"name": "html_url",
"description": "The GitHub URL of the alert resource."
},
{
"type": "string",
"name": "locations_url",
"description": "The REST API URL of the code locations for this alert."
},
{
"type": "string",
"name": "state",
"description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.",
"enum": [
"open",
"resolved"
]
},
{
"type": "string or null",
"name": "resolution",
"description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.",
"enum": [
null,
"false_positive",
"wont_fix",
"revoked",
"used_in_tests"
]
},
{
"type": "string or null",
"name": "resolved_at",
"description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
},
{
"type": "object or null",
"name": "resolved_by",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string or null",
"name": "resolution_comment",
"description": "An optional comment to resolve an alert."
},
{
"type": "string",
"name": "secret_type",
"description": "The type of secret that secret scanning detected."
},
{
"type": "string",
"name": "secret_type_display_name",
"description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security).\""
},
{
"type": "string",
"name": "secret",
"description": "The secret that was detected."
},
{
"type": "boolean or null",
"name": "push_protection_bypassed",
"description": "Whether push protection was bypassed for the detected secret."
},
{
"type": "object or null",
"name": "push_protection_bypassed_by",
"description": "A GitHub user.",
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string or null",
"name": "push_protection_bypassed_at",
"description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`."
}
]
},
{
"type": "object",
"name": "security_advisory",
"in": "body",
"description": "The details of the security advisory, including summary, description, and severity.",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "cvss",
"isRequired": true,
"childParamsGroups": [
{
"type": "number",
"name": "score",
"isRequired": true
},
{
"type": "string or null",
"name": "vector_string",
"isRequired": true
}
]
},
{
"type": "array of objects",
"name": "cwes",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "cwe_id",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "ghsa_id",
"isRequired": true
},
{
"type": "array of objects",
"name": "identifiers",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "string",
"name": "value",
"isRequired": true
}
]
},
{
"type": "string",
"name": "published_at",
"isRequired": true
},
{
"type": "array of objects",
"name": "references",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "severity",
"isRequired": true
},
{
"type": "string",
"name": "summary",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "array of objects",
"name": "vulnerabilities",
"isRequired": true,
"childParamsGroups": [
{
"type": "object or null",
"name": "first_patched_version",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "identifier",
"isRequired": true
}
]
},
{
"type": "object",
"name": "package",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "ecosystem",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
}
]
},
{
"type": "string",
"name": "severity",
"isRequired": true
},
{
"type": "string",
"name": "vulnerable_version_range",
"isRequired": true
}
]
},
{
"type": "string or null",
"name": "withdrawn_at",
"isRequired": true
}
]
},
{
"type": "object",
"name": "sponsorship",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "object",
"name": "maintainer",
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id"
},
{
"type": "string",
"name": "login"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type"
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "privacy_level",
"isRequired": true
},
{
"type": "object or null",
"name": "sponsor",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object or null",
"name": "sponsorable",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "tier",
"description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "is_custom_ammount"
},
{
"type": "boolean",
"name": "is_custom_amount"
},
{
"type": "boolean",
"name": "is_one_time",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_cents",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_dollars",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
}
]
}
]
},
{
"type": "string",
"name": "effective_date",
"in": "body",
"description": "The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect."
},
{
"type": "object",
"name": "changes",
"in": "body",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "tier",
"isRequired": true,
"childParamsGroups": [
{
"type": "object",
"name": "from",
"description": "The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "is_custom_ammount"
},
{
"type": "boolean",
"name": "is_custom_amount"
},
{
"type": "boolean",
"name": "is_one_time",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_cents",
"isRequired": true
},
{
"type": "integer",
"name": "monthly_price_in_dollars",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
}
]
}
]
}
]
},
{
"type": "object",
"name": "repository",
"in": "body",
"description": "A git repository",
"childParamsGroups": [
{
"type": "boolean",
"name": "allow_auto_merge",
"description": "Whether to allow auto-merge for pull requests.",
"default": false
},
{
"type": "boolean",
"name": "allow_forking",
"description": "Whether to allow private forks"
},
{
"type": "boolean",
"name": "allow_merge_commit",
"description": "Whether to allow merge commits for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_rebase_merge",
"description": "Whether to allow rebase merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_squash_merge",
"description": "Whether to allow squash merges for pull requests.",
"default": true
},
{
"type": "boolean",
"name": "allow_update_branch"
},
{
"type": "string",
"name": "archive_url",
"isRequired": true
},
{
"type": "boolean",
"name": "archived",
"description": "Whether the repository is archived.",
"isRequired": true,
"default": false
},
{
"type": "string",
"name": "assignees_url",
"isRequired": true
},
{
"type": "string",
"name": "blobs_url",
"isRequired": true
},
{
"type": "string",
"name": "branches_url",
"isRequired": true
},
{
"type": "string",
"name": "clone_url",
"isRequired": true
},
{
"type": "string",
"name": "collaborators_url",
"isRequired": true
},
{
"type": "string",
"name": "comments_url",
"isRequired": true
},
{
"type": "string",
"name": "commits_url",
"isRequired": true
},
{
"type": "string",
"name": "compare_url",
"isRequired": true
},
{
"type": "string",
"name": "contents_url",
"isRequired": true
},
{
"type": "string",
"name": "contributors_url",
"isRequired": true
},
{
"type": "integer or string",
"name": "created_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "default_branch",
"description": "The default branch of the repository.",
"isRequired": true
},
{
"type": "boolean",
"name": "delete_branch_on_merge",
"description": "Whether to delete head branches when pull requests are merged",
"default": false
},
{
"type": "string",
"name": "deployments_url",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "boolean",
"name": "disabled",
"description": "Returns whether or not this repository is disabled."
},
{
"type": "string",
"name": "downloads_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "boolean",
"name": "fork",
"isRequired": true
},
{
"type": "integer",
"name": "forks",
"isRequired": true
},
{
"type": "integer",
"name": "forks_count",
"isRequired": true
},
{
"type": "string",
"name": "forks_url",
"isRequired": true
},
{
"type": "string",
"name": "full_name",
"isRequired": true
},
{
"type": "string",
"name": "git_commits_url",
"isRequired": true
},
{
"type": "string",
"name": "git_refs_url",
"isRequired": true
},
{
"type": "string",
"name": "git_tags_url",
"isRequired": true
},
{
"type": "string",
"name": "git_url",
"isRequired": true
},
{
"type": "boolean",
"name": "has_downloads",
"description": "Whether downloads are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_issues",
"description": "Whether issues are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_pages",
"isRequired": true
},
{
"type": "boolean",
"name": "has_projects",
"description": "Whether projects are enabled.",
"isRequired": true,
"default": true
},
{
"type": "boolean",
"name": "has_wiki",
"description": "Whether the wiki is enabled.",
"isRequired": true,
"default": true
},
{
"type": "string or null",
"name": "homepage",
"isRequired": true
},
{
"type": "string",
"name": "hooks_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the repository",
"isRequired": true
},
{
"type": "boolean",
"name": "is_template"
},
{
"type": "string",
"name": "issue_comment_url",
"isRequired": true
},
{
"type": "string",
"name": "issue_events_url",
"isRequired": true
},
{
"type": "string",
"name": "issues_url",
"isRequired": true
},
{
"type": "string",
"name": "keys_url",
"isRequired": true
},
{
"type": "string",
"name": "labels_url",
"isRequired": true
},
{
"type": "string or null",
"name": "language",
"isRequired": true
},
{
"type": "string",
"name": "languages_url",
"isRequired": true
},
{
"type": "object or null",
"name": "license",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "key",
"isRequired": true
},
{
"type": "string",
"name": "name",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "spdx_id",
"isRequired": true
},
{
"type": "string or null",
"name": "url",
"isRequired": true
}
]
},
{
"type": "string",
"name": "master_branch"
},
{
"type": "string",
"name": "merges_url",
"isRequired": true
},
{
"type": "string",
"name": "milestones_url",
"isRequired": true
},
{
"type": "string or null",
"name": "mirror_url",
"isRequired": true
},
{
"type": "string",
"name": "name",
"description": "The name of the repository.",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "notifications_url",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues",
"isRequired": true
},
{
"type": "integer",
"name": "open_issues_count",
"isRequired": true
},
{
"type": "string",
"name": "organization"
},
{
"type": "object or null",
"name": "owner",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "avatar_url"
},
{
"type": "boolean",
"name": "deleted"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "events_url"
},
{
"type": "string",
"name": "followers_url"
},
{
"type": "string",
"name": "following_url"
},
{
"type": "string",
"name": "gists_url"
},
{
"type": "string",
"name": "gravatar_id"
},
{
"type": "string",
"name": "html_url"
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "string",
"name": "name"
},
{
"type": "string",
"name": "node_id"
},
{
"type": "string",
"name": "organizations_url"
},
{
"type": "string",
"name": "received_events_url"
},
{
"type": "string",
"name": "repos_url"
},
{
"type": "boolean",
"name": "site_admin"
},
{
"type": "string",
"name": "starred_url"
},
{
"type": "string",
"name": "subscriptions_url"
},
{
"type": "string",
"name": "type",
"enum": [
"Bot",
"User",
"Organization"
]
},
{
"type": "string",
"name": "url"
}
]
},
{
"type": "object",
"name": "permissions",
"childParamsGroups": [
{
"type": "boolean",
"name": "admin",
"isRequired": true
},
{
"type": "boolean",
"name": "maintain"
},
{
"type": "boolean",
"name": "pull",
"isRequired": true
},
{
"type": "boolean",
"name": "push",
"isRequired": true
},
{
"type": "boolean",
"name": "triage"
}
]
},
{
"type": "boolean",
"name": "private",
"description": "Whether the repository is private or public.",
"isRequired": true
},
{
"type": "boolean",
"name": "public"
},
{
"type": "string",
"name": "pulls_url",
"isRequired": true
},
{
"type": "integer or string or null",
"name": "pushed_at",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "releases_url",
"isRequired": true
},
{
"type": "string or null",
"name": "role_name"
},
{
"type": "integer",
"name": "size",
"isRequired": true
},
{
"type": "string",
"name": "ssh_url",
"isRequired": true
},
{
"type": "integer",
"name": "stargazers"
},
{
"type": "integer",
"name": "stargazers_count",
"isRequired": true
},
{
"type": "string",
"name": "stargazers_url",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "subscribers_url",
"isRequired": true
},
{
"type": "string",
"name": "subscription_url",
"isRequired": true
},
{
"type": "string",
"name": "svn_url",
"isRequired": true
},
{
"type": "string",
"name": "tags_url",
"isRequired": true
},
{
"type": "string",
"name": "teams_url",
"isRequired": true
},
{
"type": "array of strings",
"name": "topics",
"isRequired": true
},
{
"type": "string",
"name": "trees_url",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "visibility",
"isRequired": true,
"enum": [
"public",
"private",
"internal"
]
},
{
"type": "integer",
"name": "watchers",
"isRequired": true
},
{
"type": "integer",
"name": "watchers_count",
"isRequired": true
}
]
},
{
"type": "object",
"name": "deployment",
"in": "body",
"description": "A request for a specific ref(branch,sha,tag) to be deployed",
"childParamsGroups": [
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the deployment",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "sha",
"isRequired": true
},
{
"type": "string",
"name": "ref",
"description": "The ref to deploy. This can be a branch, tag, or sha.",
"isRequired": true
},
{
"type": "string",
"name": "task",
"description": "Parameter to specify a task to execute",
"isRequired": true
},
{
"type": "object or string",
"name": "payload",
"description": "",
"isRequired": true
},
{
"type": "string",
"name": "original_environment"
},
{
"type": "string",
"name": "environment",
"description": "Name for the target deployment environment.",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "object or null",
"name": "creator",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "string",
"name": "statuses_url",
"isRequired": true
},
{
"type": "string",
"name": "repository_url",
"isRequired": true
},
{
"type": "boolean",
"name": "transient_environment",
"description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false."
},
{
"type": "boolean",
"name": "production_environment",
"description": "Specifies if the given environment is one that end-users directly interact with. Default: false."
},
{
"type": "object or null",
"name": "performed_via_github_app",
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
"childParamsGroups": [
{
"type": "integer",
"name": "id",
"description": "Unique identifier of the GitHub app",
"isRequired": true
},
{
"type": "string",
"name": "slug",
"description": "The slug name of the GitHub app"
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "object or null",
"name": "owner",
"description": "A GitHub user.",
"isRequired": true,
"childParamsGroups": [
{
"type": "string or null",
"name": "name"
},
{
"type": "string or null",
"name": "email"
},
{
"type": "string",
"name": "login",
"isRequired": true
},
{
"type": "integer",
"name": "id",
"isRequired": true
},
{
"type": "string",
"name": "node_id",
"isRequired": true
},
{
"type": "string",
"name": "avatar_url",
"isRequired": true
},
{
"type": "string or null",
"name": "gravatar_id",
"isRequired": true
},
{
"type": "string",
"name": "url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "followers_url",
"isRequired": true
},
{
"type": "string",
"name": "following_url",
"isRequired": true
},
{
"type": "string",
"name": "gists_url",
"isRequired": true
},
{
"type": "string",
"name": "starred_url",
"isRequired": true
},
{
"type": "string",
"name": "subscriptions_url",
"isRequired": true
},
{
"type": "string",
"name": "organizations_url",
"isRequired": true
},
{
"type": "string",
"name": "repos_url",
"isRequired": true
},
{
"type": "string",
"name": "events_url",
"isRequired": true
},
{
"type": "string",
"name": "received_events_url",
"isRequired": true
},
{
"type": "string",
"name": "type",
"isRequired": true
},
{
"type": "boolean",
"name": "site_admin",
"isRequired": true
},
{
"type": "string",
"name": "starred_at"
}
]
},
{
"type": "string",
"name": "name",
"description": "The name of the GitHub app",
"isRequired": true
},
{
"type": "string or null",
"name": "description",
"isRequired": true
},
{
"type": "string",
"name": "external_url",
"isRequired": true
},
{
"type": "string",
"name": "html_url",
"isRequired": true
},
{
"type": "string",
"name": "created_at",
"isRequired": true
},
{
"type": "string",
"name": "updated_at",
"isRequired": true
},
{
"type": "object",
"name": "permissions",
"description": "The set of permissions for the GitHub app",
"isRequired": true,
"childParamsGroups": [
{
"type": "string",
"name": "issues"
},
{
"type": "string",
"name": "checks"
},
{
"type": "string",
"name": "metadata"
},
{
"type": "string",
"name": "contents"
},
{
"type": "string",
"name": "deployments"
}
]
},
{
"type": "array of strings",
"name": "events",
"description": "The list of events for the GitHub app",
"isRequired": true
},
{
"type": "integer",
"name": "installations_count",
"description": "The number of installations associated with the GitHub app"
},
{
"type": "string",
"name": "client_id"
},
{
"type": "string",
"name": "client_secret"
},
{
"type": "string or null",
"name": "webhook_secret"
},
{
"type": "string",
"name": "pem"
}
]
}
]
},
{
"type": "string",
"name": "action",
"in": "body",
"isRequired": true,
"enum": [
"in_progress"
]
}
]
Reference in New Issue View Git Blame Copy Permalink