From 1480138d4b67a85873a3f2bf774871c7cf87e502 Mon Sep 17 00:00:00 2001
From: Drew Powers
Date: Wed, 13 Sep 2023 10:49:48 -0600
Subject: [PATCH 1/3] Fix discriminator propertyName inference
---
.changeset/friendly-numbers-tease.md | 5 +
.../examples/github-api-next.ts | 2288 +++++---
.../examples/github-api-next.yaml | 4124 +++++++++++----
.../openapi-typescript/examples/github-api.ts | 3565 +++++++++----
.../examples/github-api.yaml | 4681 +++++++++++++----
.../openapi-typescript/examples/stripe-api.ts | 962 +++-
.../examples/stripe-api.yaml | 2645 +++++++++-
.../src/transform/schema-object.ts | 42 +-
.../openapi-typescript/test/index.test.ts | 69 +-
.../test/schema-object.test.ts | 32 +-
10 files changed, 14418 insertions(+), 3995 deletions(-)
create mode 100644 .changeset/friendly-numbers-tease.md
diff --git a/.changeset/friendly-numbers-tease.md b/.changeset/friendly-numbers-tease.md
new file mode 100644
index 000000000..8dca319cb
--- /dev/null
+++ b/.changeset/friendly-numbers-tease.md
@@ -0,0 +1,5 @@
+---
+"openapi-typescript": patch
+---
+
+Fix discriminator propertyName inference
diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts
index ab657b7c6..09475ce20 100644
--- a/packages/openapi-typescript/examples/github-api-next.ts
+++ b/packages/openapi-typescript/examples/github-api-next.ts
@@ -190,6 +190,48 @@ export interface paths {
*/
get: operations["apps/get-by-slug"];
};
+ "/assignments/{assignment_id}": {
+ /**
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/get-an-assignment"];
+ };
+ "/assignments/{assignment_id}/accepted_assignments": {
+ /**
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/list-accepted-assigments-for-an-assignment"];
+ };
+ "/assignments/{assignment_id}/grades": {
+ /**
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/get-assignment-grades"];
+ };
+ "/classrooms": {
+ /**
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ */
+ get: operations["classroom/list-classrooms"];
+ };
+ "/classrooms/{classroom_id}": {
+ /**
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ get: operations["classroom/get-a-classroom"];
+ };
+ "/classrooms/{classroom_id}/assignments": {
+ /**
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ get: operations["classroom/list-assignments-for-a-classroom"];
+ };
"/codes_of_conduct": {
/**
* Get all codes of conduct
@@ -291,6 +333,7 @@ export interface paths {
/**
* Update a gist
* @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * At least one of `description` or `files` is required.
*/
patch: operations["gists/update"];
};
@@ -5996,9 +6039,10 @@ export interface paths {
"/repos/{owner}/{repo}/rules/branches/{branch}": {
/**
* Get rules for a branch
- * @description Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- * branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- * are configured.
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
*/
get: operations["repos/get-branch-rules"];
};
@@ -8130,7 +8174,7 @@ export interface webhooks {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -8145,7 +8189,7 @@ export interface webhooks {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -8160,7 +8204,7 @@ export interface webhooks {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -8246,7 +8290,8 @@ export interface webhooks {
};
"delete": {
/**
- * This event occurs when a Git branch or tag is deleted.
+ * This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
+ * branch and tag deletions, use the [`push`](#push) webhook event.
*
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*
@@ -9956,7 +10001,9 @@ export interface webhooks {
};
"push": {
/**
- * This event occurs when a commit or tag is pushed, or when a repository is cloned.
+ * This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
+ * when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch
+ * and tag deletions, use the [`delete`](#delete) webhook event.
*
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*
@@ -10780,6 +10827,7 @@ export interface components {
/** @description The name of the CWE. */
name: string;
}[] | null;
+ /** @description The users who contributed to the advisory. */
credits: (readonly {
user: components["schemas"]["simple-user"];
type: components["schemas"]["security-advisory-credit-types"];
@@ -11378,6 +11426,7 @@ export interface components {
has_wiki: boolean;
has_pages: boolean;
/**
+ * @deprecated
* @description Whether downloads are enabled.
* @default true
*/
@@ -11698,6 +11747,223 @@ export interface components {
/** Format: date-time */
expires_at: string | null;
};
+ /**
+ * Simple Classroom Repository
+ * @description A GitHub repository view for Classroom
+ */
+ "simple-classroom-repository": {
+ /** @description A unique identifier of the repository. */
+ id: number;
+ /** @description The full, globally unique name of the repository. */
+ full_name: string;
+ /**
+ * Format: uri
+ * @description The URL to view the repository on GitHub.com.
+ */
+ html_url: string;
+ /** @description The GraphQL identifier of the repository. */
+ node_id: string;
+ /** @description Whether the repository is private. */
+ private: boolean;
+ /** @description The default branch for the repository. */
+ default_branch: string;
+ };
+ /**
+ * Organization Simple for Classroom
+ * @description A GitHub organization.
+ */
+ "simple-classroom-organization": {
+ id: number;
+ login: string;
+ node_id: string;
+ /** Format: uri */
+ html_url: string;
+ name: string | null;
+ avatar_url: string;
+ };
+ /**
+ * Classroom
+ * @description A GitHub Classroom classroom
+ */
+ classroom: {
+ /** @description Unique identifier of the classroom. */
+ id: number;
+ /** @description The name of the classroom. */
+ name: string;
+ /** @description Whether classroom is archived. */
+ archived: boolean;
+ organization: components["schemas"]["simple-classroom-organization"];
+ /** @description The URL of the classroom on GitHub Classroom. */
+ url: string;
+ };
+ /**
+ * Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "classroom-assignment": {
+ /** @description Unique identifier of the repository. */
+ id: number;
+ /** @description Whether an accepted assignment creates a public repository. */
+ public_repo: boolean;
+ /** @description Assignment title. */
+ title: string;
+ /**
+ * @description Whether it's a group assignment or individual assignment.
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /** @description The link that a student can use to accept the assignment. */
+ invite_link: string;
+ /** @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. */
+ invitations_enabled: boolean;
+ /** @description Sluggified name of the assignment. */
+ slug: string;
+ /** @description Whether students are admins on created repository when a student accepts the assignment. */
+ students_are_repo_admins: boolean;
+ /** @description Whether feedback pull request will be created when a student accepts the assignment. */
+ feedback_pull_requests_enabled: boolean;
+ /** @description The maximum allowable teams for the assignment. */
+ max_teams: number | null;
+ /** @description The maximum allowable members per team. */
+ max_members: number | null;
+ /** @description The selected editor for the assignment. */
+ editor: string;
+ /** @description The number of students that have accepted the assignment. */
+ accepted: number;
+ /** @description The number of students that have submitted the assignment. */
+ submitted: number;
+ /** @description The number of students that have passed the assignment. */
+ passing: number;
+ /** @description The programming language used in the assignment. */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ */
+ deadline: string | null;
+ starter_code_repository: components["schemas"]["simple-classroom-repository"];
+ classroom: components["schemas"]["classroom"];
+ };
+ /**
+ * Simple Classroom User
+ * @description A GitHub user simplified for Classroom.
+ */
+ "simple-classroom-user": {
+ id: number;
+ login: string;
+ /** Format: uri */
+ avatar_url: string;
+ /** Format: uri */
+ html_url: string;
+ };
+ /**
+ * Simple Classroom
+ * @description A GitHub Classroom classroom
+ */
+ "simple-classroom": {
+ /** @description Unique identifier of the classroom. */
+ id: number;
+ /** @description The name of the classroom. */
+ name: string;
+ /** @description Returns whether classroom is archived or not. */
+ archived: boolean;
+ /** @description The url of the classroom on GitHub Classroom. */
+ url: string;
+ };
+ /**
+ * Simple Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "simple-classroom-assignment": {
+ /** @description Unique identifier of the repository. */
+ id: number;
+ /** @description Whether an accepted assignment creates a public repository. */
+ public_repo: boolean;
+ /** @description Assignment title. */
+ title: string;
+ /**
+ * @description Whether it's a Group Assignment or Individual Assignment.
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /** @description The link that a student can use to accept the assignment. */
+ invite_link: string;
+ /** @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment. */
+ invitations_enabled: boolean;
+ /** @description Sluggified name of the assignment. */
+ slug: string;
+ /** @description Whether students are admins on created repository on accepted assignment. */
+ students_are_repo_admins: boolean;
+ /** @description Whether feedback pull request will be created on assignment acceptance. */
+ feedback_pull_requests_enabled: boolean;
+ /** @description The maximum allowable teams for the assignment. */
+ max_teams?: number | null;
+ /** @description The maximum allowable members per team. */
+ max_members?: number | null;
+ /** @description The selected editor for the assignment. */
+ editor: string;
+ /** @description The number of students that have accepted the assignment. */
+ accepted: number;
+ /** @description The number of students that have submitted the assignment. */
+ submitted: number;
+ /** @description The number of students that have passed the assignment. */
+ passing: number;
+ /** @description The programming language used in the assignment. */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ */
+ deadline: string | null;
+ classroom: components["schemas"]["simple-classroom"];
+ };
+ /**
+ * Classroom Accepted Assignment
+ * @description A GitHub Classroom accepted assignment
+ */
+ "classroom-accepted-assignment": {
+ /** @description Unique identifier of the repository. */
+ id: number;
+ /** @description Whether an accepted assignment has been submitted. */
+ submitted: boolean;
+ /** @description Whether a submission passed. */
+ passing: boolean;
+ /** @description Count of student commits. */
+ commit_count: number;
+ /** @description Most recent grade. */
+ grade: string;
+ students: components["schemas"]["simple-classroom-user"][];
+ repository: components["schemas"]["simple-classroom-repository"];
+ assignment: components["schemas"]["simple-classroom-assignment"];
+ };
+ /**
+ * Classroom Assignment Grade
+ * @description Grade for a student or groups GitHub Classroom assignment
+ */
+ "classroom-assignment-grade": {
+ /** @description Name of the assignment */
+ assignment_name: string;
+ /** @description URL of the assignment */
+ assignment_url: string;
+ /** @description URL of the starter code for the assignment */
+ starter_code_url: string;
+ /** @description GitHub username of the student */
+ github_username: string;
+ /** @description Roster identifier of the student */
+ roster_identifier: string;
+ /** @description Name of the student's assignment repository */
+ student_repository_name: string;
+ /** @description URL of the student's assignment repository */
+ student_repository_url: string;
+ /** @description Timestamp of the student's assignment submission */
+ submission_timestamp: string;
+ /** @description Number of points awarded to the student */
+ points_awarded: number;
+ /** @description Number of points available for the assignment */
+ points_available: number;
+ /** @description If a group assignment, name of the group the student is in */
+ group_name?: string;
+ };
/**
* Code Of Conduct
* @description Code Of Conduct
@@ -20490,7 +20756,9 @@ export interface components {
};
/**
* Simple Installation
- * @description The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
+ * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
+ * for and sent to a GitHub App. For more information,
+ * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)."
*/
"simple-installation": {
/** @description The ID of the installation. */
@@ -20498,6 +20766,445 @@ export interface components {
/** @description The global node ID of the installation. */
node_id: string;
};
+ /**
+ * Organization Simple
+ * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
+ * organization, or when the event occurs from activity in a repository owned by an organization.
+ */
+ "organization-simple-webhooks": {
+ login: string;
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ repos_url: string;
+ /** Format: uri */
+ events_url: string;
+ hooks_url: string;
+ issues_url: string;
+ members_url: string;
+ public_members_url: string;
+ avatar_url: string;
+ description: string | null;
+ };
+ /**
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
+ */
+ "repository-webhooks": {
+ /** @description Unique identifier of the repository */
+ id: number;
+ node_id: string;
+ /** @description The name of the repository. */
+ name: string;
+ full_name: string;
+ license: null | components["schemas"]["license-simple"];
+ organization?: null | components["schemas"]["simple-user"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ private: boolean;
+ /** Format: uri */
+ html_url: string;
+ description: string | null;
+ fork: boolean;
+ /** Format: uri */
+ url: string;
+ archive_url: string;
+ assignees_url: string;
+ blobs_url: string;
+ branches_url: string;
+ collaborators_url: string;
+ comments_url: string;
+ commits_url: string;
+ compare_url: string;
+ contents_url: string;
+ /** Format: uri */
+ contributors_url: string;
+ /** Format: uri */
+ deployments_url: string;
+ /** Format: uri */
+ downloads_url: string;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ forks_url: string;
+ git_commits_url: string;
+ git_refs_url: string;
+ git_tags_url: string;
+ git_url: string;
+ issue_comment_url: string;
+ issue_events_url: string;
+ issues_url: string;
+ keys_url: string;
+ labels_url: string;
+ /** Format: uri */
+ languages_url: string;
+ /** Format: uri */
+ merges_url: string;
+ milestones_url: string;
+ notifications_url: string;
+ pulls_url: string;
+ releases_url: string;
+ ssh_url: string;
+ /** Format: uri */
+ stargazers_url: string;
+ statuses_url: string;
+ /** Format: uri */
+ subscribers_url: string;
+ /** Format: uri */
+ subscription_url: string;
+ /** Format: uri */
+ tags_url: string;
+ /** Format: uri */
+ teams_url: string;
+ trees_url: string;
+ clone_url: string;
+ /** Format: uri */
+ mirror_url: string | null;
+ /** Format: uri */
+ hooks_url: string;
+ /** Format: uri */
+ svn_url: string;
+ /** Format: uri */
+ homepage: string | null;
+ language: string | null;
+ forks_count: number;
+ stargazers_count: number;
+ watchers_count: number;
+ /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */
+ size: number;
+ /** @description The default branch of the repository. */
+ default_branch: string;
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ */
+ has_discussions?: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
+ /** Format: date-time */
+ pushed_at: string | null;
+ /** Format: date-time */
+ created_at: string | null;
+ /** Format: date-time */
+ updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ */
+ allow_rebase_merge?: boolean;
+ template_repository?: ({
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
+ };
+ private?: boolean;
+ html_url?: string;
+ description?: string;
+ fork?: boolean;
+ url?: string;
+ archive_url?: string;
+ assignees_url?: string;
+ blobs_url?: string;
+ branches_url?: string;
+ collaborators_url?: string;
+ comments_url?: string;
+ commits_url?: string;
+ compare_url?: string;
+ contents_url?: string;
+ contributors_url?: string;
+ deployments_url?: string;
+ downloads_url?: string;
+ events_url?: string;
+ forks_url?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ pulls_url?: string;
+ releases_url?: string;
+ ssh_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ clone_url?: string;
+ mirror_url?: string;
+ hooks_url?: string;
+ svn_url?: string;
+ homepage?: string;
+ language?: string;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
+ is_template?: boolean;
+ topics?: string[];
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
+ visibility?: string;
+ pushed_at?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
+ allow_squash_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_update_branch?: boolean;
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ }) | null;
+ temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ */
+ allow_squash_merge?: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ */
+ allow_auto_merge?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @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
+ */
+ allow_update_branch?: boolean;
+ /**
+ * @deprecated
+ * @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
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ */
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ anonymous_access_enabled?: boolean;
+ };
+ /**
+ * Simple User
+ * @description The GitHub user that triggered the event. This property is included in every webhook payload.
+ */
+ "simple-user-webhooks": {
+ name?: string | null;
+ email?: string | null;
+ login: string;
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ avatar_url: string;
+ gravatar_id: string | null;
+ /** Format: uri */
+ url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: uri */
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ starred_url: string;
+ /** Format: uri */
+ subscriptions_url: string;
+ /** Format: uri */
+ organizations_url: string;
+ /** Format: uri */
+ repos_url: string;
+ events_url: string;
+ /** Format: uri */
+ received_events_url: string;
+ type: string;
+ site_admin: boolean;
+ starred_at?: string;
+ };
/** @description A suite of checks performed on the code of a given code change */
"simple-check-suite": {
after?: string | null;
@@ -20878,9 +21585,9 @@ export interface components {
action: "disabled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection configuration enabled event */
"webhook-branch-protection-configuration-enabled": {
@@ -20888,9 +21595,9 @@ export interface components {
action: "enabled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule created event */
"webhook-branch-protection-rule-created": {
@@ -20898,8 +21605,8 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -20944,7 +21651,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule deleted event */
"webhook-branch-protection-rule-deleted": {
@@ -20952,8 +21659,8 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -20998,7 +21705,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule edited event */
"webhook-branch-protection-rule-edited": {
@@ -21032,8 +21739,8 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -21078,7 +21785,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Check Run Completed Event */
"webhook-check-run-completed": {
@@ -21086,9 +21793,9 @@ export interface components {
action?: "completed";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Completed Event
@@ -21104,9 +21811,9 @@ export interface components {
action?: "created";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Created Event
@@ -21122,14 +21829,14 @@ export interface components {
action: "requested_action";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The action requested by the user. */
requested_action?: {
/** @description The integrator reference of the action requested by the user. */
identifier?: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Requested Action Event
@@ -21145,9 +21852,9 @@ export interface components {
action?: "rerequested";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Re-Requested Event
@@ -21394,9 +22101,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** check_suite requested event */
"webhook-check-suite-requested": {
@@ -21635,9 +22342,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** check_suite rerequested event */
"webhook-check-suite-rerequested": {
@@ -21876,9 +22583,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert appeared_in_branch event */
"webhook-code-scanning-alert-appeared-in-branch": {
@@ -22002,11 +22709,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert closed_by_user event */
"webhook-code-scanning-alert-closed-by-user": {
@@ -22137,11 +22844,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert created event */
"webhook-code-scanning-alert-created": {
@@ -22234,11 +22941,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert fixed event */
"webhook-code-scanning-alert-fixed": {
@@ -22371,11 +23078,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert reopened event */
"webhook-code-scanning-alert-reopened": {
@@ -22464,11 +23171,11 @@ export interface components {
commit_oid: string | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string | null;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert reopened_by_user event */
"webhook-code-scanning-alert-reopened-by-user": {
@@ -22550,11 +23257,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** commit_comment created event */
"webhook-commit-comment-created": {
@@ -22645,9 +23352,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** create event */
"webhook-create": {
@@ -22657,7 +23364,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The name of the repository's default branch (usually `main`). */
master_branch: string;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pusher type for the event. Can be either `user` or a deploy key. */
pusher_type: string;
/** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
@@ -22667,14 +23374,14 @@ export interface components {
* @enum {string}
*/
ref_type: "tag" | "branch";
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** delete event */
"webhook-delete": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pusher type for the event. Can be either `user` or a deploy key. */
pusher_type: string;
/** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
@@ -22684,8 +23391,8 @@ export interface components {
* @enum {string}
*/
ref_type: "tag" | "branch";
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert auto-dismissed event */
"webhook-dependabot-alert-auto-dismissed": {
@@ -22693,10 +23400,10 @@ export interface components {
action: "auto_dismissed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert auto-reopened event */
"webhook-dependabot-alert-auto-reopened": {
@@ -22704,10 +23411,10 @@ export interface components {
action: "auto_reopened";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert created event */
"webhook-dependabot-alert-created": {
@@ -22715,10 +23422,10 @@ export interface components {
action: "created";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert dismissed event */
"webhook-dependabot-alert-dismissed": {
@@ -22726,10 +23433,10 @@ export interface components {
action: "dismissed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert fixed event */
"webhook-dependabot-alert-fixed": {
@@ -22737,10 +23444,10 @@ export interface components {
action: "fixed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert reintroduced event */
"webhook-dependabot-alert-reintroduced": {
@@ -22748,10 +23455,10 @@ export interface components {
action: "reintroduced";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert reopened event */
"webhook-dependabot-alert-reopened": {
@@ -22759,10 +23466,10 @@ export interface components {
action: "reopened";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deploy_key created event */
"webhook-deploy-key-created": {
@@ -22783,9 +23490,9 @@ export interface components {
url: string;
verified: boolean;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deploy_key deleted event */
"webhook-deploy-key-deleted": {
@@ -22806,9 +23513,9 @@ export interface components {
url: string;
verified: boolean;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deployment created event */
"webhook-deployment-created": {
@@ -23012,9 +23719,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -23329,10 +24036,10 @@ export interface components {
deployment_callback_url?: string;
deployment?: components["schemas"]["deployment"];
pull_requests?: components["schemas"]["pull-request"][];
- repository?: components["schemas"]["repository"];
- organization?: components["schemas"]["organization-simple"];
+ repository?: components["schemas"]["repository-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
installation?: components["schemas"]["simple-installation"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-deployment-review-approved": {
/** @enum {string} */
@@ -23360,8 +24067,8 @@ export interface components {
comment?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
reviewers?: ({
/** User */
reviewer?: ({
@@ -23403,7 +24110,7 @@ export interface components {
/** @enum {string} */
type?: "User";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run?: {
conclusion: null;
@@ -23732,8 +24439,8 @@ export interface components {
comment?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
reviewers?: ({
/** User */
reviewer?: ({
@@ -23775,7 +24482,7 @@ export interface components {
/** @enum {string} */
type?: "User";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run?: {
conclusion: null;
@@ -24084,8 +24791,8 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
environment: string;
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requestor: ({
/** Format: uri */
@@ -24164,7 +24871,7 @@ export interface components {
/** @enum {string} */
type?: "User" | "Team";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run: {
conclusion: null;
@@ -24884,9 +25591,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow?: {
/** Format: uri */
@@ -25264,9 +25971,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion category changed event */
"webhook-discussion-category-changed": {
@@ -25292,9 +25999,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion closed event */
"webhook-discussion-closed": {
@@ -25303,9 +26010,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment created event */
"webhook-discussion-comment-created": {
@@ -25383,9 +26090,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment deleted event */
"webhook-discussion-comment-deleted": {
@@ -25463,9 +26170,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment edited event */
"webhook-discussion-comment-edited": {
@@ -25548,9 +26255,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion created event */
"webhook-discussion-created": {
@@ -25751,9 +26458,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion deleted event */
"webhook-discussion-deleted": {
@@ -25762,9 +26469,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion edited event */
"webhook-discussion-edited": {
@@ -25781,9 +26488,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion labeled event */
"webhook-discussion-labeled": {
@@ -25808,9 +26515,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion locked event */
"webhook-discussion-locked": {
@@ -25819,9 +26526,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion pinned event */
"webhook-discussion-pinned": {
@@ -25830,9 +26537,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion reopened event */
"webhook-discussion-reopened": {
@@ -25841,9 +26548,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion transferred event */
"webhook-discussion-transferred": {
@@ -25851,14 +26558,14 @@ export interface components {
action: "transferred";
changes: {
new_discussion: components["schemas"]["discussion"];
- new_repository: components["schemas"]["repository"];
+ new_repository: components["schemas"]["repository-webhooks"];
};
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unanswered event */
"webhook-discussion-unanswered": {
@@ -25936,9 +26643,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** discussion unlabeled event */
"webhook-discussion-unlabeled": {
@@ -25963,9 +26670,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unlocked event */
"webhook-discussion-unlocked": {
@@ -25974,9 +26681,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unpinned event */
"webhook-discussion-unpinned": {
@@ -25985,9 +26692,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* fork event
@@ -26329,9 +27036,9 @@ export interface components {
watchers_count?: number;
});
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** github_app_authorization revoked event */
"webhook-github-app-authorization-revoked": {
@@ -26339,15 +27046,15 @@ export interface components {
action: "revoked";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** gollum event */
"webhook-gollum": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pages that were updated. */
pages: ({
/**
@@ -26368,8 +27075,8 @@ export interface components {
/** @description The current page title. */
title: string;
})[];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation created event */
"webhook-installation-created": {
@@ -26377,7 +27084,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -26389,7 +27096,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/** User */
requester?: ({
/** Format: uri */
@@ -26427,7 +27134,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation deleted event */
"webhook-installation-deleted": {
@@ -26435,7 +27142,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -26447,9 +27154,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation new_permissions_accepted event */
"webhook-installation-new-permissions-accepted": {
@@ -26457,7 +27164,7 @@ export interface components {
action: "new_permissions_accepted";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -26469,9 +27176,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation_repositories added event */
"webhook-installation-repositories-added": {
@@ -26479,7 +27186,7 @@ export interface components {
action: "added";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects, which were added to the installation. */
repositories_added: {
full_name: string;
@@ -26502,7 +27209,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private?: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description Describe whether all repositories have been selected or there's a selection involved
* @enum {string}
@@ -26545,7 +27252,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation_repositories removed event */
"webhook-installation-repositories-removed": {
@@ -26553,7 +27260,7 @@ export interface components {
action: "removed";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects, which were added to the installation. */
repositories_added: {
full_name: string;
@@ -26576,7 +27283,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description Describe whether all repositories have been selected or there's a selection involved
* @enum {string}
@@ -26619,7 +27326,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation suspend event */
"webhook-installation-suspend": {
@@ -26627,7 +27334,7 @@ export interface components {
action: "suspend";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -26639,9 +27346,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
"webhook-installation-target-renamed": {
account: {
@@ -26694,9 +27401,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
target_type: string;
};
/** installation unsuspend event */
@@ -26705,7 +27412,7 @@ export interface components {
action: "unsuspend";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -26717,9 +27424,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment created event */
"webhook-issue-comment-created": {
@@ -27331,9 +28038,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment deleted event */
"webhook-issue-comment-deleted": {
@@ -27945,9 +28652,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment edited event */
"webhook-issue-comment-edited": {
@@ -28566,9 +29273,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues assigned event */
"webhook-issues-assigned": {
@@ -29026,9 +29733,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues closed event */
"webhook-issues-closed": {
@@ -29505,9 +30212,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues deleted event */
"webhook-issues-deleted": {
@@ -29925,9 +30632,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues demilestoned event */
"webhook-issues-demilestoned": {
@@ -30540,9 +31247,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues edited event */
"webhook-issues-edited": {
@@ -30987,9 +31694,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues labeled event */
"webhook-issues-labeled": {
@@ -31423,9 +32130,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues locked event */
"webhook-issues-locked": {
@@ -31899,9 +32606,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues milestoned event */
"webhook-issues-milestoned": {
@@ -32514,9 +33221,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues opened event */
"webhook-issues-opened": {
@@ -33581,9 +34288,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues pinned event */
"webhook-issues-pinned": {
@@ -34001,9 +34708,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues reopened event */
"webhook-issues-reopened": {
@@ -34476,9 +35183,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues transferred event */
"webhook-issues-transferred": {
@@ -35550,9 +36257,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unassigned event */
"webhook-issues-unassigned": {
@@ -36010,9 +36717,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unlabeled event */
"webhook-issues-unlabeled": {
@@ -36446,9 +37153,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unlocked event */
"webhook-issues-unlocked": {
@@ -36921,9 +37628,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unpinned event */
"webhook-issues-unpinned": {
@@ -37341,9 +38048,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** label created event */
"webhook-label-created": {
@@ -37367,9 +38074,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** label deleted event */
"webhook-label-deleted": {
@@ -37393,9 +38100,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** label edited event */
"webhook-label-edited": {
@@ -37434,9 +38141,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase cancelled event */
"webhook-marketplace-purchase-cancelled": {
@@ -37496,7 +38203,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -37524,8 +38231,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase changed event */
"webhook-marketplace-purchase-changed": {
@@ -37585,7 +38292,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -37613,8 +38320,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase pending_change event */
"webhook-marketplace-purchase-pending-change": {
@@ -37674,7 +38381,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -37702,8 +38409,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase pending_change_cancelled event */
"webhook-marketplace-purchase-pending-change-cancelled": {
@@ -37740,7 +38447,7 @@ export interface components {
}) & {
next_billing_date: string;
};
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -37768,8 +38475,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase purchased event */
"webhook-marketplace-purchase-purchased": {
@@ -37829,7 +38536,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -37857,8 +38564,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member added event */
"webhook-member-added": {
@@ -37909,9 +38616,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member edited event */
"webhook-member-edited": {
@@ -37967,9 +38674,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member removed event */
"webhook-member-removed": {
@@ -38014,9 +38721,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** membership added event */
"webhook-membership-added": {
@@ -38061,8 +38768,8 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
@@ -38211,8 +38918,8 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
@@ -38323,9 +39030,9 @@ export interface components {
action: "checks_requested";
installation?: components["schemas"]["simple-installation"];
merge_group: components["schemas"]["merge-group"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-merge-group-destroyed": {
/** @enum {string} */
@@ -38337,9 +39044,9 @@ export interface components {
reason?: "merged" | "invalidated" | "dequeued";
installation?: components["schemas"]["simple-installation"];
merge_group: components["schemas"]["merge-group"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** meta deleted event */
"webhook-meta-deleted": {
@@ -38367,9 +39074,9 @@ export interface components {
/** @description The id of the modified webhook. */
hook_id: number;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: null | components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: null | components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** milestone closed event */
"webhook-milestone-closed": {
@@ -38448,9 +39155,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone created event */
"webhook-milestone-created": {
@@ -38529,9 +39236,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone deleted event */
"webhook-milestone-deleted": {
@@ -38610,9 +39317,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone edited event */
"webhook-milestone-edited": {
@@ -38706,9 +39413,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone opened event */
"webhook-milestone-opened": {
@@ -38787,9 +39494,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** org_block blocked event */
"webhook-org-block-blocked": {
@@ -38834,9 +39541,9 @@ export interface components {
}) | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** org_block unblocked event */
"webhook-org-block-unblocked": {
@@ -38881,9 +39588,9 @@ export interface components {
}) | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization deleted event */
"webhook-organization-deleted": {
@@ -38940,9 +39647,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization member_added event */
"webhook-organization-member-added": {
@@ -38999,9 +39706,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization member_invited event */
"webhook-organization-member-invited": {
@@ -39063,9 +39770,9 @@ export interface components {
team_count: number;
invitation_source?: string;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** User */
user?: ({
/** Format: uri */
@@ -39159,9 +39866,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization renamed event */
"webhook-organization-renamed": {
@@ -39223,9 +39930,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Ruby Gems metadata */
"webhook-rubygems-metadata": {
@@ -39252,7 +39959,7 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
package: {
created_at: string | null;
@@ -39500,8 +40207,8 @@ export interface components {
} | null;
updated_at: string | null;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** package updated event */
"webhook-package-updated": {
@@ -39509,7 +40216,7 @@ export interface components {
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
package: {
created_at: string;
@@ -39701,8 +40408,8 @@ export interface components {
} | null;
updated_at: string;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** page_build event */
"webhook-page-build": {
@@ -39759,17 +40466,17 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
id: number;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** personal_access_token_request approved event */
"webhook-personal-access-token-request-approved": {
/** @enum {string} */
action: "approved";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request cancelled event */
@@ -39777,8 +40484,8 @@ export interface components {
/** @enum {string} */
action: "cancelled";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request created event */
@@ -39786,8 +40493,8 @@ export interface components {
/** @enum {string} */
action: "created";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request denied event */
@@ -39795,8 +40502,8 @@ export interface components {
/** @enum {string} */
action: "denied";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
"webhook-ping": {
@@ -39841,9 +40548,9 @@ export interface components {
};
/** @description The ID of the webhook that triggered the ping. */
hook_id?: number;
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/** @description Random string of GitHub zen. */
zen?: string;
};
@@ -39863,7 +40570,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -39924,8 +40631,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card created event */
"webhook-project-card-created": {
@@ -39933,7 +40640,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -39994,8 +40701,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card deleted event */
"webhook-project-card-deleted": {
@@ -40003,7 +40710,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -40064,8 +40771,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: null | components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: null | components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card edited event */
"webhook-project-card-edited": {
@@ -40078,7 +40785,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -40139,8 +40846,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card moved event */
"webhook-project-card-moved": {
@@ -40153,7 +40860,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
project_card: ({
after_id?: number | null;
/** @description Whether or not the card is archived */
@@ -40245,8 +40952,8 @@ export interface components {
updated_at?: string;
url?: string;
});
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project closed event */
"webhook-project-closed": {
@@ -40254,7 +40961,7 @@ export interface components {
action: "closed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -40319,8 +41026,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_column created event */
"webhook-project-column-created": {
@@ -40328,7 +41035,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -40348,8 +41055,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column deleted event */
"webhook-project-column-deleted": {
@@ -40357,7 +41064,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -40377,8 +41084,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: null | components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: null | components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column edited event */
"webhook-project-column-edited": {
@@ -40391,7 +41098,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -40411,8 +41118,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column moved event */
"webhook-project-column-moved": {
@@ -40420,7 +41127,7 @@ export interface components {
action: "moved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -40440,8 +41147,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project created event */
"webhook-project-created": {
@@ -40449,7 +41156,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -40514,8 +41221,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project deleted event */
"webhook-project-deleted": {
@@ -40523,7 +41230,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -40588,8 +41295,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: null | components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: null | components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project edited event */
"webhook-project-edited": {
@@ -40608,7 +41315,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -40673,8 +41380,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project reopened event */
"webhook-project-reopened": {
@@ -40682,7 +41389,7 @@ export interface components {
action: "reopened";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -40747,35 +41454,35 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Closed Event */
"webhook-projects-v2-project-closed": {
/** @enum {string} */
action: "closed";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** @description A project was created */
"webhook-projects-v2-project-created": {
/** @enum {string} */
action: "created";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Deleted Event */
"webhook-projects-v2-project-deleted": {
/** @enum {string} */
action: "deleted";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Edited Event */
"webhook-projects-v2-project-edited": {
@@ -40800,9 +41507,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Archived Event */
"webhook-projects-v2-item-archived": {
@@ -40817,9 +41524,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Converted Event */
"webhook-projects-v2-item-converted": {
@@ -40832,27 +41539,27 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Created Event */
"webhook-projects-v2-item-created": {
/** @enum {string} */
action: "created";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Deleted Event */
"webhook-projects-v2-item-deleted": {
/** @enum {string} */
action: "deleted";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Edited Event */
"webhook-projects-v2-item-edited": {
@@ -40870,9 +41577,9 @@ export interface components {
};
}]>;
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Reordered Event */
"webhook-projects-v2-item-reordered": {
@@ -40885,9 +41592,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Restored Event */
"webhook-projects-v2-item-restored": {
@@ -40902,26 +41609,26 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Reopened Event */
"webhook-projects-v2-project-reopened": {
/** @enum {string} */
action: "reopened";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** public event */
"webhook-public": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request assigned event */
"webhook-pull-request-assigned": {
@@ -40968,7 +41675,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -42146,8 +42853,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request auto_merge_disabled event */
"webhook-pull-request-auto-merge-disabled": {
@@ -42156,7 +42863,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -43335,8 +44042,8 @@ export interface components {
}) | null;
};
reason: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request auto_merge_enabled event */
"webhook-pull-request-auto-merge-enabled": {
@@ -43345,7 +44052,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -44524,8 +45231,8 @@ export interface components {
}) | null;
};
reason?: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request closed event */
"webhook-pull-request-closed": {
@@ -44535,7 +45242,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -44585,8 +45292,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request converted_to_draft event */
"webhook-pull-request-converted-to-draft": {
@@ -44596,7 +45303,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -44646,8 +45353,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request demilestoned event */
"webhook-pull-request-demilestoned": {
@@ -44657,7 +45364,7 @@ export interface components {
milestone?: components["schemas"]["milestone"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -45835,8 +46542,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request dequeued event */
"webhook-pull-request-dequeued": {
@@ -45845,7 +46552,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -47024,8 +47731,8 @@ export interface components {
}) | null;
};
reason: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request edited event */
"webhook-pull-request-edited": {
@@ -47054,7 +47761,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -47104,8 +47811,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request enqueued event */
"webhook-pull-request-enqueued": {
@@ -47114,7 +47821,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -48292,8 +48999,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request labeled event */
"webhook-pull-request-labeled": {
@@ -48319,7 +49026,7 @@ export interface components {
};
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -49497,8 +50204,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request locked event */
"webhook-pull-request-locked": {
@@ -49508,7 +50215,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -50686,8 +51393,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request milestoned event */
"webhook-pull-request-milestoned": {
@@ -50697,7 +51404,7 @@ export interface components {
milestone?: components["schemas"]["milestone"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -51875,8 +52582,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request opened event */
"webhook-pull-request-opened": {
@@ -51886,7 +52593,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -51936,8 +52643,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request ready_for_review event */
"webhook-pull-request-ready-for-review": {
@@ -51947,7 +52654,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -51997,8 +52704,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request reopened event */
"webhook-pull-request-reopened": {
@@ -52008,7 +52715,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -52058,8 +52765,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment created event */
"webhook-pull-request-review-comment-created": {
@@ -52212,7 +52919,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -53330,8 +54037,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment deleted event */
"webhook-pull-request-review-comment-deleted": {
@@ -53484,7 +54191,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -54602,8 +55309,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment edited event */
"webhook-pull-request-review-comment-edited": {
@@ -54763,7 +55470,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -55881,8 +56588,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review dismissed event */
"webhook-pull-request-review-dismissed": {
@@ -55890,7 +56597,7 @@ export interface components {
action: "dismissed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -57009,7 +57716,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -57083,7 +57790,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review edited event */
"webhook-pull-request-review-edited": {
@@ -57097,7 +57804,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -58124,7 +58831,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -58197,7 +58904,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request review_request_removed event */
"webhook-pull-request-review-request-removed": OneOf<[{
@@ -58207,7 +58914,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -59378,7 +60085,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requested_reviewer: ({
/** Format: uri */
@@ -59416,7 +60123,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}, {
/** @enum {string} */
action: "review_request_removed";
@@ -59424,7 +60131,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -60602,7 +61309,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -60658,7 +61365,7 @@ export interface components {
*/
url: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}]>;
/** pull_request review_requested event */
"webhook-pull-request-review-requested": OneOf<[{
@@ -60668,7 +61375,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -61846,7 +62553,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requested_reviewer: ({
/** Format: uri */
@@ -61884,7 +62591,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}, {
/** @enum {string} */
action: "review_requested";
@@ -61892,7 +62599,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -63070,7 +63777,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -63126,7 +63833,7 @@ export interface components {
*/
url?: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}]>;
/** pull_request_review submitted event */
"webhook-pull-request-review-submitted": {
@@ -63134,7 +63841,7 @@ export interface components {
action: "submitted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -64253,7 +64960,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -64326,7 +65033,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_thread resolved event */
"webhook-pull-request-review-thread-resolved": {
@@ -64334,7 +65041,7 @@ export interface components {
action: "resolved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -65375,8 +66082,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
thread: {
comments: ({
_links: {
@@ -65528,7 +66235,7 @@ export interface components {
action: "unresolved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -66569,8 +67276,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
thread: {
comments: ({
_links: {
@@ -66726,7 +67433,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -67897,8 +68604,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unassigned event */
"webhook-pull-request-unassigned": {
@@ -67945,7 +68652,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -69123,8 +69830,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unlabeled event */
"webhook-pull-request-unlabeled": {
@@ -69150,7 +69857,7 @@ export interface components {
};
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -70321,8 +71028,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unlocked event */
"webhook-pull-request-unlocked": {
@@ -70332,7 +71039,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -71510,8 +72217,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** push event */
"webhook-push": {
@@ -71632,7 +72339,7 @@ export interface components {
url: string;
}) | null;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Committer
* @description Metaproperties for Git author/committer information.
@@ -71890,14 +72597,14 @@ export interface components {
/** @description Whether to require contributors to sign off on web-based commits */
web_commit_signoff_required?: boolean;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-registry-package-published": {
/** @enum {string} */
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
registry_package: {
created_at: string | null;
description: string | null;
@@ -72085,15 +72792,15 @@ export interface components {
} | null;
updated_at: string | null;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
"webhook-registry-package-updated": {
/** @enum {string} */
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
registry_package: {
created_at: string;
description: null;
@@ -72218,8 +72925,8 @@ export interface components {
registry: Record | null;
updated_at: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release created event */
"webhook-release-created": {
@@ -72227,7 +72934,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -72375,8 +73082,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release deleted event */
"webhook-release-deleted": {
@@ -72384,7 +73091,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -72532,8 +73239,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release edited event */
"webhook-release-edited": {
@@ -72555,7 +73262,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -72703,8 +73410,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release prereleased event */
"webhook-release-prereleased": {
@@ -72712,7 +73419,7 @@ export interface components {
action: "prereleased";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -72898,8 +73605,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release published event */
"webhook-release-published": {
@@ -72907,7 +73614,7 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -73090,8 +73797,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release released event */
"webhook-release-released": {
@@ -73099,7 +73806,7 @@ export interface components {
action: "released";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -73247,8 +73954,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release unpublished event */
"webhook-release-unpublished": {
@@ -73256,7 +73963,7 @@ export interface components {
action: "unpublished";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -73438,8 +74145,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Repository advisory published event */
"webhook-repository-advisory-published": {
@@ -73447,10 +74154,10 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
repository_advisory: components["schemas"]["repository-advisory"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Repository advisory reported event */
"webhook-repository-advisory-reported": {
@@ -73458,10 +74165,10 @@ export interface components {
action: "reported";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
repository_advisory: components["schemas"]["repository-advisory"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** repository archived event */
"webhook-repository-archived": {
@@ -73469,9 +74176,9 @@ export interface components {
action: "archived";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository created event */
"webhook-repository-created": {
@@ -73479,9 +74186,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository deleted event */
"webhook-repository-deleted": {
@@ -73489,9 +74196,9 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_dispatch event */
"webhook-repository-dispatch-sample": {
@@ -73503,9 +74210,9 @@ export interface components {
} | null;
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository edited event */
"webhook-repository-edited": {
@@ -73527,17 +74234,17 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_import event */
"webhook-repository-import": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @enum {string} */
status: "success" | "cancelled" | "failure";
};
@@ -73547,9 +74254,9 @@ export interface components {
action: "privatized";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository publicized event */
"webhook-repository-publicized": {
@@ -73557,9 +74264,9 @@ export interface components {
action: "publicized";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository renamed event */
"webhook-repository-renamed": {
@@ -73574,9 +74281,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset created event */
"webhook-repository-ruleset-created": {
@@ -73584,10 +74291,10 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset deleted event */
"webhook-repository-ruleset-deleted": {
@@ -73595,10 +74302,10 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset edited event */
"webhook-repository-ruleset-edited": {
@@ -73606,8 +74313,8 @@ export interface components {
action: "edited";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
changes?: {
name?: {
@@ -73656,7 +74363,7 @@ export interface components {
}[];
};
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository transferred event */
"webhook-repository-transferred": {
@@ -73732,9 +74439,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository unarchived event */
"webhook-repository-unarchived": {
@@ -73742,9 +74449,9 @@ export interface components {
action: "unarchived";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert create event */
"webhook-repository-vulnerability-alert-create": {
@@ -73824,9 +74531,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert dismiss event */
"webhook-repository-vulnerability-alert-dismiss": {
@@ -73947,9 +74654,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert reopen event */
"webhook-repository-vulnerability-alert-reopen": {
@@ -74029,9 +74736,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert resolve event */
"webhook-repository-vulnerability-alert-resolve": {
@@ -74114,9 +74821,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert created event */
"webhook-secret-scanning-alert-created": {
@@ -74125,9 +74832,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Secret Scanning Alert Location Created Event */
"webhook-secret-scanning-alert-location-created": {
@@ -74136,9 +74843,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
installation?: components["schemas"]["simple-installation"];
location: components["schemas"]["secret-scanning-location"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Secret Scanning Alert Location Created Event */
"webhook-secret-scanning-alert-location-created-form-encoded": {
@@ -74152,9 +74859,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert resolved event */
"webhook-secret-scanning-alert-resolved": {
@@ -74163,9 +74870,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert revoked event */
"webhook-secret-scanning-alert-revoked": {
@@ -74174,9 +74881,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory published event */
"webhook-security-advisory-published": {
@@ -74184,8 +74891,8 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -74223,7 +74930,7 @@ export interface components {
})[];
withdrawn_at: string | null;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory updated event */
"webhook-security-advisory-updated": {
@@ -74231,8 +74938,8 @@ export interface components {
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -74270,7 +74977,7 @@ export interface components {
})[];
withdrawn_at: string | null;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory withdrawn event */
"webhook-security-advisory-withdrawn": {
@@ -74278,8 +74985,8 @@ export interface components {
action: "withdrawn";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -74317,7 +75024,7 @@ export interface components {
})[];
withdrawn_at: string;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_and_analysis event */
"webhook-security-and-analysis": {
@@ -74328,9 +75035,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
repository: components["schemas"]["full-repository"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** sponsorship cancelled event */
"webhook-sponsorship-cancelled": {
@@ -74338,9 +75045,9 @@ export interface components {
action: "cancelled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -74462,9 +75169,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -74592,9 +75299,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -74718,9 +75425,9 @@ export interface components {
effective_date?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -74863,9 +75570,9 @@ export interface components {
effective_date?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -75006,9 +75713,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -75130,9 +75837,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */
starred_at: string | null;
};
@@ -75142,9 +75849,9 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */
starred_at: null;
};
@@ -75306,9 +76013,9 @@ export interface components {
id: number;
installation?: components["schemas"]["simple-installation"];
name: string;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The Commit SHA. */
sha: string;
/**
@@ -75324,9 +76031,9 @@ export interface components {
"webhook-team-add": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -75399,7 +76106,7 @@ export interface components {
action: "added_to_repository";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -75635,7 +76342,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -75708,7 +76415,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -75944,7 +76651,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -76017,7 +76724,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -76253,7 +76960,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -76357,7 +77064,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -76593,7 +77300,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -76666,7 +77373,7 @@ export interface components {
action: "removed_from_repository";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -76902,7 +77609,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -76975,9 +77682,9 @@ export interface components {
action: "started";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** workflow_dispatch event */
"webhook-workflow-dispatch": {
@@ -76986,10 +77693,10 @@ export interface components {
[key: string]: unknown;
} | null;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow: string;
};
/** workflow_job completed event */
@@ -76998,9 +77705,9 @@ export interface components {
action: "completed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: ({
/** Format: uri */
check_run_url: string;
@@ -77088,9 +77795,9 @@ export interface components {
action: "in_progress";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: ({
/** Format: uri */
check_run_url: string;
@@ -77186,9 +77893,9 @@ export interface components {
action: "queued";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: {
/** Format: uri */
check_run_url: string;
@@ -77240,9 +77947,9 @@ export interface components {
action: "waiting";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: {
/** Format: uri */
check_run_url: string;
@@ -77294,9 +78001,9 @@ export interface components {
action: "completed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -77981,9 +78688,9 @@ export interface components {
action: "in_progress";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -78668,9 +79375,9 @@ export interface components {
action: "requested";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -79325,6 +80032,10 @@ export interface components {
/** @description The client ID of the GitHub app. */
"client-id": string;
"app-slug": string;
+ /** @description The unique identifier of the classroom assignment. */
+ "assignment-id": number;
+ /** @description The unique identifier of the classroom. */
+ "classroom-id": number;
/** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
enterprise: string;
/**
@@ -80235,6 +80946,132 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /**
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-an-assignment": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/list-accepted-assigments-for-an-assignment": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-accepted-assignment"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-assignment-grades": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment-grade"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ */
+ "classroom/list-classrooms": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/get-a-classroom": {
+ parameters: {
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/list-assignments-for-a-classroom": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom-assignment"][];
+ };
+ };
+ };
+ };
/**
* Get all codes of conduct
* @description Returns array of all GitHub's codes of conduct.
@@ -80571,6 +81408,7 @@ export interface operations {
/**
* Update a gist
* @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * At least one of `description` or `files` is required.
*/
"gists/update": {
parameters: {
@@ -80587,7 +81425,8 @@ export interface operations {
* @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
* (including extension) of the targeted gist file. For example: `hello.py`.
*
- * To delete a file, set the whole file to null. For example: `hello.py : null`.
+ * To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be
+ * deleted if the specified object does not contain at least one of `content` or `filename`.
*/
files?: {
[key: string]: ({
@@ -82127,6 +82966,8 @@ export interface operations {
"actions/list-self-hosted-runners-for-org": {
parameters: {
query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
};
@@ -89242,6 +90083,8 @@ export interface operations {
"actions/list-self-hosted-runners-for-repo": {
parameters: {
query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
};
@@ -95160,11 +96003,8 @@ export interface operations {
* @default
*/
description?: string;
- /**
- * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.
- * @enum {string}
- */
- environment?: "production" | "staging" | "qa";
+ /** @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */
+ environment?: string;
/**
* @description Sets the URL for accessing your environment. Default: `""`
* @default
@@ -100872,9 +101712,10 @@ export interface operations {
};
/**
* Get rules for a branch
- * @description Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- * branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- * are configured.
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
*/
"repos/get-branch-rules": {
parameters: {
@@ -107864,7 +108705,7 @@ export interface operations {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -107907,7 +108748,7 @@ export interface operations {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -107950,7 +108791,7 @@ export interface operations {
*
* For activity relating to check runs, use the `check_run` event.
*
- * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ * To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
*
* Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
*
@@ -108288,7 +109129,8 @@ export interface operations {
};
};
/**
- * This event occurs when a Git branch or tag is deleted.
+ * This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
+ * branch and tag deletions, use the [`push`](#push) webhook event.
*
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*
@@ -114367,7 +115209,9 @@ export interface operations {
};
};
/**
- * This event occurs when a commit or tag is pushed, or when a repository is cloned.
+ * This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
+ * when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch
+ * and tag deletions, use the [`delete`](#delete) webhook event.
*
* To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
*
diff --git a/packages/openapi-typescript/examples/github-api-next.yaml b/packages/openapi-typescript/examples/github-api-next.yaml
index 51c192b81..6c3c71ce3 100644
--- a/packages/openapi-typescript/examples/github-api-next.yaml
+++ b/packages/openapi-typescript/examples/github-api-next.yaml
@@ -83,6 +83,8 @@ tags:
description: Manage security advisories.
- name: interactions
description: Owner or admin management of users interactions.
+- name: classroom
+ description: Interact with GitHub Classroom.
servers:
- url: https://api.github.com
externalDocs:
@@ -1146,6 +1148,193 @@ paths:
enabledForGitHubApps: true
category: apps
subcategory: apps
+ "/assignments/{assignment_id}":
+ get:
+ summary: Get an assignment
+ description: Gets a GitHub Classroom assignment. Assignment will only be returned
+ if the current user is an administrator of the GitHub Classroom for the assignment.
+ tags:
+ - classroom
+ operationId: classroom/get-an-assignment
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-an-assignment
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/classroom-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-assignment"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/assignments/{assignment_id}/accepted_assignments":
+ get:
+ summary: List accepted assignments for an assignment
+ description: Lists any assignment repositories that have been created by students
+ accepting a GitHub Classroom assignment. Accepted assignments will only be
+ returned if the current user is an administrator of the GitHub Classroom for
+ the assignment.
+ tags:
+ - classroom
+ operationId: classroom/list-accepted-assigments-for-an-assignment
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/classroom-accepted-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-accepted-assignment"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/assignments/{assignment_id}/grades":
+ get:
+ summary: Get assignment grades
+ description: Gets grades for a GitHub Classroom assignment. Grades will only
+ be returned if the current user is an administrator of the GitHub Classroom
+ for the assignment.
+ tags:
+ - classroom
+ operationId: classroom/get-assignment-grades
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/classroom-assignment-grade"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-assignment-grades"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms":
+ get:
+ summary: List classrooms
+ description: Lists GitHub Classroom classrooms for the current user. Classrooms
+ will only be returned if the current user is an administrator of one or more
+ GitHub Classrooms.
+ tags:
+ - classroom
+ operationId: classroom/list-classrooms
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-classrooms
+ parameters:
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom"
+ examples:
+ default:
+ "$ref": "#/components/examples/simple-classroom"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms/{classroom_id}":
+ get:
+ summary: Get a classroom
+ description: Gets a GitHub Classroom classroom for the current user. Classroom
+ will only be returned if the current user is an administrator of the GitHub
+ Classroom.
+ tags:
+ - classroom
+ operationId: classroom/get-a-classroom
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-a-classroom
+ parameters:
+ - "$ref": "#/components/parameters/classroom-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/classroom"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms/{classroom_id}/assignments":
+ get:
+ summary: List assignments for a classroom
+ description: Lists GitHub Classroom assignments for a classroom. Assignments
+ will only be returned if the current user is an administrator of the GitHub
+ Classroom.
+ tags:
+ - classroom
+ operationId: classroom/list-assignments-for-a-classroom
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
+ parameters:
+ - "$ref": "#/components/parameters/classroom-id"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/simple-classroom-assignment"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
"/codes_of_conduct":
get:
summary: Get all codes of conduct
@@ -1666,9 +1855,9 @@ paths:
subcategory: gists
patch:
summary: Update a gist
- description: Allows you to update a gist's description and to update, delete,
- or rename gist files. Files from the previous version of the gist that aren't
- explicitly changed during an edit are unchanged.
+ description: |-
+ Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ At least one of `description` or `files` is required.
tags:
- gists
operationId: gists/update
@@ -1693,7 +1882,8 @@ paths:
The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
(including extension) of the targeted gist file. For example: `hello.py`.
- To delete a file, set the whole file to null. For example: `hello.py : null`.
+ To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be
+ deleted if the specified object does not contain at least one of `content` or `filename`.
type: object
additionalProperties:
type:
@@ -1708,22 +1898,10 @@ paths:
type:
- string
- 'null'
- anyOf:
- - required:
- - content
- - required:
- - filename
- - type: object
- maxProperties: 0
examples:
- hello.rb:
content: blah
filename: goodbye.rb
- anyOf:
- - required:
- - description
- - required:
- - files
type:
- object
- 'null'
@@ -4177,6 +4355,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization
parameters:
+ - name: name
+ description: The name of a self-hosted runner.
+ in: query
+ schema:
+ type: string
- "$ref": "#/components/parameters/org"
- "$ref": "#/components/parameters/per-page"
- "$ref": "#/components/parameters/page"
@@ -14856,6 +15039,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository
parameters:
+ - name: name
+ description: The name of a self-hosted runner.
+ in: query
+ schema:
+ type: string
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/per-page"
@@ -21398,7 +21586,7 @@ paths:
- 'null'
examples:
default:
- "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository"
+ "$ref": "#/components/examples/codespaces-default-attributes-for-a-codespace"
'401':
"$ref": "#/components/responses/requires_authentication"
'403':
@@ -24165,11 +24353,9 @@ paths:
type: string
description: Name for the target deployment environment, which can
be changed when setting a deploy status. For example, `production`,
- `staging`, or `qa`.
- enum:
- - production
- - staging
- - qa
+ `staging`, or `qa`. If not defined, the environment of the previous
+ status on the deployment will be used, if it exists. Otherwise,
+ the environment of the deployment will be used.
environment_url:
type: string
description: 'Sets the URL for accessing your environment. Default:
@@ -24735,7 +24921,8 @@ paths:
type: array
items:
"$ref": "#/components/schemas/deployment-protection-rule"
- example: "../../components/examples/deployment_protection_rules.yaml"
+ example:
+ "$ref": "#/components/examples/deployment-protection-rules"
examples:
default:
value:
@@ -33220,9 +33407,10 @@ paths:
get:
summary: Get rules for a branch
description: |-
- Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- are configured.
+ Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ enforcement statuses are not returned.
tags:
- repos
operationId: repos/get-branch-rules
@@ -43685,7 +43873,7 @@ webhooks:
description: All branch protections were disabled for a repository.
operationId: branch-protection-configuration/disabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-configuration
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration
parameters:
- name: User-Agent
in: header
@@ -43735,7 +43923,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-configuration
+ subcategory: branch_protection_configuration
supported-webhook-types:
- repository
- organization
@@ -43751,7 +43939,7 @@ webhooks:
description: All branch protections were enabled for a repository.
operationId: branch-protection-configuration/enabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-configuration
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration
parameters:
- name: User-Agent
in: header
@@ -43801,7 +43989,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-configuration
+ subcategory: branch_protection_configuration
supported-webhook-types:
- repository
- organization
@@ -43815,7 +44003,7 @@ webhooks:
description: A branch protection rule was created.
operationId: branch-protection-rule/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43865,7 +44053,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -43879,7 +44067,7 @@ webhooks:
description: A branch protection rule was deleted.
operationId: branch-protection-rule/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43929,7 +44117,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -43943,7 +44131,7 @@ webhooks:
description: A branch protection rule was edited.
operationId: branch-protection-rule/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43993,7 +44181,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -44013,7 +44201,7 @@ webhooks:
description: A check run was completed, and a conclusion is available.
operationId: check-run/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44093,7 +44281,7 @@ webhooks:
description: A new check run was created.
operationId: check-run/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44176,7 +44364,7 @@ webhooks:
see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)."
operationId: check-run/requested-action
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44257,7 +44445,7 @@ webhooks:
someone requests to re-run the check will receive the `rerequested` payload.
operationId: check-run/rerequested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44329,7 +44517,7 @@ webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44338,7 +44526,7 @@ webhooks:
is available.
operationId: check-suite/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44388,7 +44576,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44400,7 +44588,7 @@ webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44412,7 +44600,7 @@ webhooks:
in the REST API documentation.
operationId: check-suite/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44462,7 +44650,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44474,7 +44662,7 @@ webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44486,7 +44674,7 @@ webhooks:
in the REST API documentation.
operationId: check-suite/rerequested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44536,7 +44724,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44552,7 +44740,7 @@ webhooks:
a pre-existing code scanning alert.
operationId: code-scanning-alert/appeared-in-branch
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44602,7 +44790,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44616,7 +44804,7 @@ webhooks:
description: Someone closed a code scanning alert.
operationId: code-scanning-alert/closed-by-user
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44666,7 +44854,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44680,7 +44868,7 @@ webhooks:
description: A code scanning alert was created in a repository.
operationId: code-scanning-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44730,7 +44918,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44744,7 +44932,7 @@ webhooks:
description: A code scanning alert was fixed in a branch by a commit.
operationId: code-scanning-alert/fixed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44794,7 +44982,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44808,7 +44996,7 @@ webhooks:
description: A previously fixed code scanning alert reappeared in a branch.
operationId: code-scanning-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44858,7 +45046,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44872,7 +45060,7 @@ webhooks:
description: Someone reopened a code scanning alert.
operationId: code-scanning-alert/reopened-by-user
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44922,7 +45110,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44938,7 +45126,7 @@ webhooks:
description: Someone commented on a commit.
operationId: commit-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment
parameters:
- name: User-Agent
in: header
@@ -44988,7 +45176,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: commit-comment
+ subcategory: commit_comment
supported-webhook-types:
- repository
- organization
@@ -45003,7 +45191,7 @@ webhooks:
**Note**: This event will not occur when more than three tags are created at once.
operationId: create
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#create
parameters:
- name: User-Agent
in: header
@@ -45061,14 +45249,15 @@ webhooks:
delete:
post:
summary: |-
- This event occurs when a Git branch or tag is deleted.
+ This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
+ branch and tag deletions, use the [`push`](#push) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: This event will not occur when more than three tags are deleted at once.
operationId: delete
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete
parameters:
- name: User-Agent
in: header
@@ -45136,7 +45325,7 @@ webhooks:
description: A Dependabot alert was automatically closed.
operationId: dependabot-alert/auto-dismissed
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45186,7 +45375,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45204,7 +45393,7 @@ webhooks:
description: A Dependabot alert was automatically reopened.
operationId: dependabot-alert/auto-reopened
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45254,7 +45443,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45274,7 +45463,7 @@ webhooks:
to be vulnerable.
operationId: dependabot-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45324,7 +45513,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45342,7 +45531,7 @@ webhooks:
description: A Dependabot alert was manually closed.
operationId: dependabot-alert/dismissed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45392,7 +45581,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45410,7 +45599,7 @@ webhooks:
description: A manifest file change removed a vulnerability.
operationId: dependabot-alert/fixed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45460,7 +45649,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45479,7 +45668,7 @@ webhooks:
had previously been fixed.
operationId: dependabot-alert/reintroduced
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45529,7 +45718,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45547,7 +45736,7 @@ webhooks:
description: A Dependabot alert was manually reopened.
operationId: dependabot-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45597,7 +45786,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45611,7 +45800,7 @@ webhooks:
description: A deploy key was created.
operationId: deploy-key/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
@@ -45661,7 +45850,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deploy-key
+ subcategory: deploy_key
supported-webhook-types:
- repository
- organization
@@ -45675,7 +45864,7 @@ webhooks:
description: A deploy key was deleted.
operationId: deploy-key/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
@@ -45725,7 +45914,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deploy-key
+ subcategory: deploy_key
supported-webhook-types:
- repository
- organization
@@ -45741,7 +45930,7 @@ webhooks:
description: A deployment was created.
operationId: deployment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment
parameters:
- name: User-Agent
in: header
@@ -45805,7 +45994,7 @@ webhooks:
description: A deployment protection rule was requested for an environment.
operationId: deployment-protection-rule/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule
parameters:
- name: User-Agent
in: header
@@ -45855,7 +46044,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-protection-rule
+ subcategory: deployment_protection_rule
supported-webhook-types:
- app
deployment-review-approved:
@@ -45869,7 +46058,7 @@ webhooks:
description: A deployment review was approved.
operationId: deployment-review/approved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -45919,7 +46108,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-rejected:
@@ -45933,7 +46122,7 @@ webhooks:
description: A deployment review was rejected.
operationId: deployment-review/rejected
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -45983,7 +46172,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-requested:
@@ -45997,7 +46186,7 @@ webhooks:
description: A deployment review was requested.
operationId: deployment-review/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -46047,7 +46236,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-status-created:
@@ -46061,7 +46250,7 @@ webhooks:
description: A new deployment status was created.
operationId: deployment-status/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_status
parameters:
- name: User-Agent
in: header
@@ -46111,7 +46300,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-status
+ subcategory: deployment_status
supported-webhook-types:
- repository
- organization
@@ -46129,7 +46318,7 @@ webhooks:
description: A comment on the discussion was marked as the answer.
operationId: discussion/answered
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46197,7 +46386,7 @@ webhooks:
description: The category of a discussion was changed.
operationId: discussion/category-changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46265,7 +46454,7 @@ webhooks:
description: A discussion was closed.
operationId: discussion/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46333,7 +46522,7 @@ webhooks:
description: A comment on a discussion was created.
operationId: discussion-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46383,7 +46572,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46401,7 +46590,7 @@ webhooks:
description: A comment on a discussion was deleted.
operationId: discussion-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46451,7 +46640,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46469,7 +46658,7 @@ webhooks:
description: A comment on a discussion was edited.
operationId: discussion-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46519,7 +46708,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46537,7 +46726,7 @@ webhooks:
description: A discussion was created.
operationId: discussion/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46605,7 +46794,7 @@ webhooks:
description: A discussion was deleted.
operationId: discussion/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46674,7 +46863,7 @@ webhooks:
the discussion was changed.
operationId: discussion/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46742,7 +46931,7 @@ webhooks:
description: A label was added to a discussion.
operationId: discussion/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46810,7 +46999,7 @@ webhooks:
description: A discussion was locked.
operationId: discussion/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46878,7 +47067,7 @@ webhooks:
description: A discussion was pinned.
operationId: discussion/pinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46946,7 +47135,7 @@ webhooks:
description: A discussion was reopened.
operationId: discussion/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47014,7 +47203,7 @@ webhooks:
description: A discussion was transferred to another repository.
operationId: discussion/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47082,7 +47271,7 @@ webhooks:
description: A comment on the discussion was unmarked as the answer.
operationId: discussion/unanswered
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47150,7 +47339,7 @@ webhooks:
description: A label was removed from a discussion.
operationId: discussion/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47218,7 +47407,7 @@ webhooks:
description: A discussion was unlocked.
operationId: discussion/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47286,7 +47475,7 @@ webhooks:
description: A discussion was unpinned.
operationId: discussion/unpinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47349,7 +47538,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: fork
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#fork
parameters:
- name: User-Agent
in: header
@@ -47416,7 +47605,7 @@ webhooks:
description: Someone revoked their authorization of a GitHub App.
operationId: github-app-authorization/revoked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#github_app_authorization
parameters:
- name: User-Agent
in: header
@@ -47466,7 +47655,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: github-app-authorization
+ subcategory: github_app_authorization
supported-webhook-types:
- app
gollum:
@@ -47477,7 +47666,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: gollum
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#gollum
parameters:
- name: User-Agent
in: header
@@ -47541,7 +47730,7 @@ webhooks:
description: Someone installed a GitHub App on a user or organization account.
operationId: installation/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47604,7 +47793,7 @@ webhooks:
account.
operationId: installation/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47666,7 +47855,7 @@ webhooks:
description: Someone granted new permissions to a GitHub App.
operationId: installation/new-permissions-accepted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47728,7 +47917,7 @@ webhooks:
description: A GitHub App installation was granted access to one or more repositories.
operationId: installation-repositories/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
@@ -47778,7 +47967,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-repositories
+ subcategory: installation_repositories
supported-webhook-types:
- app
installation-repositories-removed:
@@ -47791,7 +47980,7 @@ webhooks:
installation.
operationId: installation-repositories/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
@@ -47841,7 +48030,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-repositories
+ subcategory: installation_repositories
supported-webhook-types:
- app
installation-suspend:
@@ -47854,7 +48043,7 @@ webhooks:
account.
operationId: installation/suspend
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47919,7 +48108,7 @@ webhooks:
App is installed on.
operationId: installation-target/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_target
parameters:
- name: User-Agent
in: header
@@ -47969,7 +48158,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-target
+ subcategory: installation_target
supported-webhook-types:
- app
installation-unsuspend:
@@ -47982,7 +48171,7 @@ webhooks:
account was given access the account again.
operationId: installation/unsuspend
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -48046,7 +48235,7 @@ webhooks:
description: A comment on an issue or pull request was created.
operationId: issue-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -48096,7 +48285,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -48112,7 +48301,7 @@ webhooks:
description: A comment on an issue or pull request was deleted.
operationId: issue-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -48162,7 +48351,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -48178,7 +48367,7 @@ webhooks:
description: A comment on an issue or pull request was edited.
operationId: issue-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -48228,7 +48417,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -48244,7 +48433,7 @@ webhooks:
description: An issue was assigned to a user.
operationId: issues/assigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48310,7 +48499,7 @@ webhooks:
description: An issue was closed.
operationId: issues/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48376,7 +48565,7 @@ webhooks:
description: An issue was deleted.
operationId: issues/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48442,7 +48631,7 @@ webhooks:
description: An issue was removed from a milestone.
operationId: issues/demilestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48508,7 +48697,7 @@ webhooks:
description: The title or body on an issue was edited.
operationId: issues/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48574,7 +48763,7 @@ webhooks:
description: A label was added to an issue.
operationId: issues/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48641,7 +48830,7 @@ webhooks:
"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48707,7 +48896,7 @@ webhooks:
description: An issue was added to a milestone.
operationId: issues/milestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48774,7 +48963,7 @@ webhooks:
will be `reopened` instead.
operationId: issues/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48841,7 +49030,7 @@ webhooks:
"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/pinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48907,7 +49096,7 @@ webhooks:
description: A closed issue was reopened.
operationId: issues/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48974,7 +49163,7 @@ webhooks:
see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)."
operationId: issues/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49040,7 +49229,7 @@ webhooks:
description: A user was unassigned from an issue.
operationId: issues/unassigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49106,7 +49295,7 @@ webhooks:
description: A label was removed from an issue.
operationId: issues/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49173,7 +49362,7 @@ webhooks:
"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49240,7 +49429,7 @@ webhooks:
see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/unpinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49306,7 +49495,7 @@ webhooks:
description: A label was created.
operationId: label/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49372,7 +49561,7 @@ webhooks:
description: A label was deleted.
operationId: label/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49438,7 +49627,7 @@ webhooks:
description: A label's name, description, or color was changed.
operationId: label/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49505,7 +49694,7 @@ webhooks:
cycle has ended. The change will take effect on the account immediately.
operationId: marketplace-purchase/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49555,7 +49744,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-changed:
@@ -49570,7 +49759,7 @@ webhooks:
last billing cycle has ended. The change will take effect on the account immediately.
operationId: marketplace-purchase/changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49620,7 +49809,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-pending-change:
@@ -49637,7 +49826,7 @@ webhooks:
be sent.
operationId: marketplace-purchase/pending-change
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49687,7 +49876,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-pending-change-cancelled:
@@ -49703,7 +49892,7 @@ webhooks:
at the end of a billing cycle.
operationId: marketplace-purchase/pending-change-cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49753,7 +49942,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-purchased:
@@ -49768,7 +49957,7 @@ webhooks:
effect on the account immediately.
operationId: marketplace-purchase/purchased
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49818,7 +50007,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
member-added:
@@ -49830,7 +50019,7 @@ webhooks:
description: A GitHub user accepted an invitation to a repository.
operationId: member/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -49895,7 +50084,7 @@ webhooks:
description: Permissions were changed for a collaborator on a repository.
operationId: member/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -49960,7 +50149,7 @@ webhooks:
description: A collaborator was removed from a repository.
operationId: member/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -50025,7 +50214,7 @@ webhooks:
description: An organization member was added to a team.
operationId: membership/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
@@ -50089,7 +50278,7 @@ webhooks:
description: An organization member was removed from a team.
operationId: membership/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
@@ -50158,7 +50347,7 @@ webhooks:
tags:
- merge-queue
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group
parameters:
- name: User-Agent
in: header
@@ -50208,7 +50397,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: merge-group
+ subcategory: merge_group
supported-webhook-types:
- app
merge-group-destroyed:
@@ -50225,7 +50414,7 @@ webhooks:
tags:
- merge-queue
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group
parameters:
- name: User-Agent
in: header
@@ -50275,7 +50464,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: merge-group
+ subcategory: merge_group
supported-webhook-types:
- app
meta-deleted:
@@ -50287,7 +50476,7 @@ webhooks:
description: The webhook was deleted.
operationId: meta/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta
parameters:
- name: User-Agent
in: header
@@ -50355,7 +50544,7 @@ webhooks:
description: A milestone was closed.
operationId: milestone/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50421,7 +50610,7 @@ webhooks:
description: A milestone was created.
operationId: milestone/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50487,7 +50676,7 @@ webhooks:
description: A milestone was deleted.
operationId: milestone/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50553,7 +50742,7 @@ webhooks:
description: A milestone was edited.
operationId: milestone/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50619,7 +50808,7 @@ webhooks:
description: A milestone was opened.
operationId: milestone/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50685,7 +50874,7 @@ webhooks:
description: A user was blocked from the organization.
operationId: org-block/blocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block
parameters:
- name: User-Agent
in: header
@@ -50735,7 +50924,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: org-block
+ subcategory: org_block
supported-webhook-types:
- organization
- business
@@ -50751,7 +50940,7 @@ webhooks:
description: A previously blocked user was unblocked from the organization.
operationId: org-block/unblocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block
parameters:
- name: User-Agent
in: header
@@ -50801,7 +50990,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: org-block
+ subcategory: org_block
supported-webhook-types:
- organization
- business
@@ -50817,7 +51006,7 @@ webhooks:
description: An organization was deleted.
operationId: organization/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50883,7 +51072,7 @@ webhooks:
description: A member accepted an invitation to join an organization.
operationId: organization/member-added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50949,7 +51138,7 @@ webhooks:
description: A member was invited to join the organization.
operationId: organization/member-invited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -51015,7 +51204,7 @@ webhooks:
description: A member was removed from the organization.
operationId: organization/member-removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -51081,7 +51270,7 @@ webhooks:
description: The name of an organization was changed.
operationId: organization/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -51145,7 +51334,7 @@ webhooks:
description: A package was published to a registry.
operationId: package/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
@@ -51209,7 +51398,7 @@ webhooks:
description: A previously published package was updated.
operationId: package/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
@@ -51272,7 +51461,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.
operationId: page-build
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build
parameters:
- name: User-Agent
in: header
@@ -51322,7 +51511,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: page-build
+ subcategory: page_build
supported-webhook-types:
- repository
- organization
@@ -51338,7 +51527,7 @@ webhooks:
description: A fine-grained personal access token request was approved.
operationId: personal-access-token-request/approved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51388,7 +51577,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-cancelled:
@@ -51403,7 +51592,7 @@ webhooks:
requester.
operationId: personal-access-token-request/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51453,7 +51642,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-created:
@@ -51467,7 +51656,7 @@ webhooks:
description: A fine-grained personal access token request was created.
operationId: personal-access-token-request/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51517,7 +51706,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-denied:
@@ -51531,7 +51720,7 @@ webhooks:
description: A fine-grained personal access token request was denied.
operationId: personal-access-token-request/denied
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51581,7 +51770,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
ping:
@@ -51590,7 +51779,7 @@ webhooks:
a confirmation from GitHub that you configured the webhook correctly.
operationId: ping
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping
parameters:
- name: User-Agent
in: header
@@ -51668,7 +51857,7 @@ webhooks:
description: A note in a classic project was converted to an issue.
operationId: project-card/converted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51718,7 +51907,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51734,7 +51923,7 @@ webhooks:
description: A card was added to a classic project.
operationId: project-card/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51784,7 +51973,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51800,7 +51989,7 @@ webhooks:
description: A card on a classic project was deleted.
operationId: project-card/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51850,7 +52039,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51866,7 +52055,7 @@ webhooks:
description: A note on a classic project was edited.
operationId: project-card/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51916,7 +52105,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51933,7 +52122,7 @@ webhooks:
position in its column.
operationId: project-card/moved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51983,7 +52172,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51999,7 +52188,7 @@ webhooks:
description: A classic project was closed.
operationId: project/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52065,7 +52254,7 @@ webhooks:
description: A column was added to a classic project.
operationId: project-column/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52115,7 +52304,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52131,7 +52320,7 @@ webhooks:
description: A column was deleted from a classic project.
operationId: project-column/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52181,7 +52370,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52197,7 +52386,7 @@ webhooks:
description: The name of a column on a classic project was changed.
operationId: project-column/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52247,7 +52436,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52263,7 +52452,7 @@ webhooks:
description: A column was moved to a new position on a classic project.
operationId: project-column/moved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52313,7 +52502,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52329,7 +52518,7 @@ webhooks:
description: A classic project was created.
operationId: project/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52395,7 +52584,7 @@ webhooks:
description: A classic project was deleted.
operationId: project/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52461,7 +52650,7 @@ webhooks:
description: The name or description of a classic project was changed.
operationId: project/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52527,7 +52716,7 @@ webhooks:
description: A classic project was closed.
operationId: project/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52595,7 +52784,7 @@ webhooks:
description: A project in the organization was closed.
operationId: projects-v2/closed
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52662,7 +52851,7 @@ webhooks:
description: A project in the organization was created.
operationId: projects-v2/created
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52729,7 +52918,7 @@ webhooks:
description: A project in the organization was deleted.
operationId: projects-v2/deleted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52797,7 +52986,7 @@ webhooks:
was changed.
operationId: projects-v2/edited
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52865,7 +53054,7 @@ webhooks:
see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/archived
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52932,7 +53121,7 @@ webhooks:
description: A draft issue in an organization project was converted to an issue.
operationId: projects-v2-item/converted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52999,7 +53188,7 @@ webhooks:
description: An item was added to a project in the organization.
operationId: projects-v2-item/created
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53066,7 +53255,7 @@ webhooks:
description: An item was deleted from a project in the organization.
operationId: projects-v2-item/deleted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53135,7 +53324,7 @@ webhooks:
issue was changed, or a draft issue was converted to an issue.
operationId: projects-v2-item/edited
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53204,7 +53393,7 @@ webhooks:
board layout.
operationId: projects-v2-item/reordered
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53272,7 +53461,7 @@ webhooks:
archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/restored
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53339,7 +53528,7 @@ webhooks:
description: A project in the organization was reopened.
operationId: projects-v2/reopened
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -53401,7 +53590,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
operationId: public
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#public
parameters:
- name: User-Agent
in: header
@@ -53467,7 +53656,7 @@ webhooks:
description: A pull request was assigned to a user.
operationId: pull-request/assigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53517,7 +53706,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53534,7 +53723,7 @@ webhooks:
see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-disabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53584,7 +53773,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53601,7 +53790,7 @@ webhooks:
see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-enabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53651,7 +53840,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53669,7 +53858,7 @@ webhooks:
true in the webhook payload, the pull request was merged.
operationId: pull-request/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53719,7 +53908,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53736,7 +53925,7 @@ webhooks:
see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/converted-to-draft
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53786,7 +53975,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53802,7 +53991,7 @@ webhooks:
description: A pull request was removed from a milestone.
operationId: pull-request/demilestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53852,7 +54041,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53868,7 +54057,7 @@ webhooks:
description: A pull request was removed from the merge queue.
operationId: pull-request/dequeued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53918,7 +54107,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53934,7 +54123,7 @@ webhooks:
description: The title or body of a pull request was edited.
operationId: pull-request/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53984,7 +54173,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54000,7 +54189,7 @@ webhooks:
description: A pull request was added to the merge queue.
operationId: pull-request/enqueued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54050,7 +54239,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54066,7 +54255,7 @@ webhooks:
description: A label was added to a pull request.
operationId: pull-request/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54116,7 +54305,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54133,7 +54322,7 @@ webhooks:
see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54183,7 +54372,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54199,7 +54388,7 @@ webhooks:
description: A pull request was added to a milestone.
operationId: pull-request/milestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54249,7 +54438,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54265,7 +54454,7 @@ webhooks:
description: A pull request was created
operationId: pull-request/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54315,7 +54504,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54332,7 +54521,7 @@ webhooks:
see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/ready-for-review
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54382,7 +54571,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54398,7 +54587,7 @@ webhooks:
description: A previously closed pull request was reopened.
operationId: pull-request/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54448,7 +54637,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54464,7 +54653,7 @@ webhooks:
description: A comment on a pull request diff was created.
operationId: pull-request-review-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54514,7 +54703,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54530,7 +54719,7 @@ webhooks:
description: A comment on a pull request diff was deleted.
operationId: pull-request-review-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54580,7 +54769,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54596,7 +54785,7 @@ webhooks:
description: The content of a comment on a pull request diff was changed.
operationId: pull-request-review-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54646,7 +54835,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54662,7 +54851,7 @@ webhooks:
description: A review on a pull request was dismissed.
operationId: pull-request-review/dismissed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54712,7 +54901,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54728,7 +54917,7 @@ webhooks:
description: The body comment on a pull request review was edited.
operationId: pull-request-review/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54778,7 +54967,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54795,7 +54984,7 @@ webhooks:
request.
operationId: pull-request/review-request-removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54845,7 +55034,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54862,7 +55051,7 @@ webhooks:
more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)."
operationId: pull-request/review-requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54912,7 +55101,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54928,7 +55117,7 @@ webhooks:
description: A review on a pull request was submitted.
operationId: pull-request-review/submitted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54978,7 +55167,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54994,7 +55183,7 @@ webhooks:
description: A comment thread on a pull request was marked as resolved.
operationId: pull-request-review-thread/resolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
@@ -55044,7 +55233,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-thread
+ subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
@@ -55061,7 +55250,7 @@ webhooks:
as unresolved.
operationId: pull-request-review-thread/unresolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
@@ -55111,7 +55300,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-thread
+ subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
@@ -55129,7 +55318,7 @@ webhooks:
head branch.
operationId: pull-request/synchronize
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55179,7 +55368,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55195,7 +55384,7 @@ webhooks:
description: A user was unassigned from a pull request.
operationId: pull-request/unassigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55245,7 +55434,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55261,7 +55450,7 @@ webhooks:
description: A label was removed from a pull request.
operationId: pull-request/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55311,7 +55500,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55328,7 +55517,7 @@ webhooks:
see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55378,7 +55567,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55386,14 +55575,16 @@ webhooks:
push:
post:
summary: |-
- This event occurs when a commit or tag is pushed, or when a repository is cloned.
+ This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
+ when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch
+ and tag deletions, use the [`delete`](#delete) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: An event will not be created when more than three tags are pushed at once.
operationId: push
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#push
parameters:
- name: User-Agent
in: header
@@ -55459,7 +55650,7 @@ webhooks:
description: A package was published to a registry.
operationId: registry-package/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#registry-package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
@@ -55509,7 +55700,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: registry-package
+ subcategory: registry_package
supported-webhook-types:
- repository
- organization
@@ -55525,7 +55716,7 @@ webhooks:
description: A package that was previously published to a registry was updated.
operationId: registry-package/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#registry-package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
@@ -55575,7 +55766,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: registry-package
+ subcategory: registry_package
supported-webhook-types:
- repository
- organization
@@ -55590,7 +55781,7 @@ webhooks:
previously being saved as a draft.
operationId: release/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55654,7 +55845,7 @@ webhooks:
description: A release, pre-release, or draft release was deleted.
operationId: release/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55719,7 +55910,7 @@ webhooks:
For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)."
operationId: release/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55784,7 +55975,7 @@ webhooks:
is a release that is not ready for production and may be unstable.
operationId: release/prereleased
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55848,7 +56039,7 @@ webhooks:
description: A release, pre-release, or draft of a release was published.
operationId: release/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55912,7 +56103,7 @@ webhooks:
description: A release was published, or a pre-release was changed to a release.
operationId: release/released
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55976,7 +56167,7 @@ webhooks:
description: A release or pre-release was unpublished.
operationId: release/unpublished
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -56040,7 +56231,7 @@ webhooks:
description: A repository security advisory was published.
operationId: repository-advisory/published
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory
parameters:
- name: User-Agent
in: header
@@ -56090,7 +56281,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-advisory
+ subcategory: repository_advisory
supported-webhook-types:
- repository
- organization
@@ -56104,7 +56295,7 @@ webhooks:
description: A private vulnerability report was submitted.
operationId: repository-advisory/reported
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory
parameters:
- name: User-Agent
in: header
@@ -56154,7 +56345,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-advisory
+ subcategory: repository_advisory
supported-webhook-types:
- repository
- organization
@@ -56168,7 +56359,7 @@ webhooks:
description: A repository was archived.
operationId: repository/archived
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56233,7 +56424,7 @@ webhooks:
description: A repository was created.
operationId: repository/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56299,7 +56490,7 @@ webhooks:
not receive this event.
operationId: repository/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56365,7 +56556,7 @@ webhooks:
request body.
operationId: repository-dispatch/sample.collected
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-dispatch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch
parameters:
- name: User-Agent
in: header
@@ -56415,7 +56606,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-dispatch
+ subcategory: repository_dispatch
supported-webhook-types:
- app
repository-edited:
@@ -56428,7 +56619,7 @@ webhooks:
was changed.
operationId: repository/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56491,7 +56682,7 @@ webhooks:
For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).
operationId: repository-import
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-import
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import
parameters:
- name: User-Agent
in: header
@@ -56541,7 +56732,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-import
+ subcategory: repository_import
supported-webhook-types:
- repository
- organization
@@ -56554,7 +56745,7 @@ webhooks:
description: The visibility of a repository was changed to `private`.
operationId: repository/privatized
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56619,7 +56810,7 @@ webhooks:
description: The visibility of a repository was changed to `public`.
operationId: repository/publicized
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56684,7 +56875,7 @@ webhooks:
description: The name of a repository was changed.
operationId: repository/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56751,7 +56942,7 @@ webhooks:
description: A repository ruleset was created.
operationId: repository-ruleset/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56801,7 +56992,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56817,7 +57008,7 @@ webhooks:
description: A repository ruleset was deleted.
operationId: repository-ruleset/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56867,7 +57058,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56883,7 +57074,7 @@ webhooks:
description: A repository ruleset was edited.
operationId: repository-ruleset/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56933,7 +57124,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56951,7 +57142,7 @@ webhooks:
events.
operationId: repository/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -57016,7 +57207,7 @@ webhooks:
description: A previously archived repository was unarchived.
operationId: repository/unarchived
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -57081,7 +57272,7 @@ webhooks:
description: A repository vulnerability alert was created.
operationId: repository-vulnerability-alert/create
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57131,7 +57322,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57144,7 +57335,7 @@ webhooks:
description: A repository vulnerability alert was dismissed.
operationId: repository-vulnerability-alert/dismiss
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57194,7 +57385,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57208,7 +57399,7 @@ webhooks:
was reopened.
operationId: repository-vulnerability-alert/reopen
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57258,7 +57449,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57271,7 +57462,7 @@ webhooks:
description: A repository vulnerability alert was marked as resolved.
operationId: repository-vulnerability-alert/resolve
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57321,7 +57512,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57336,7 +57527,7 @@ webhooks:
description: A secret scanning alert was created.
operationId: secret-scanning-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57386,7 +57577,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57405,7 +57596,7 @@ webhooks:
a repository, and the location of the secret was added to the existing alert.
operationId: secret-scanning-alert-location/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location
parameters:
- name: User-Agent
in: header
@@ -57481,7 +57672,7 @@ webhooks:
description: A previously closed secret scanning alert was reopened.
operationId: secret-scanning-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57531,7 +57722,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57547,7 +57738,7 @@ webhooks:
description: A secret scanning alert was closed.
operationId: secret-scanning-alert/resolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57597,7 +57788,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57613,7 +57804,7 @@ webhooks:
description: A secret scanning alert was marked as revoked.
operationId: secret-scanning-alert/revoked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57663,7 +57854,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57677,7 +57868,7 @@ webhooks:
description: A security advisory was published to the GitHub community.
operationId: security-advisory/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57727,7 +57918,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-updated:
@@ -57740,7 +57931,7 @@ webhooks:
or the security advisory was withdrawn.
operationId: security-advisory/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57790,7 +57981,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-withdrawn:
@@ -57802,7 +57993,7 @@ webhooks:
description: A previously published security advisory was withdrawn.
operationId: security-advisory/withdrawn
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57852,7 +58043,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-and-analysis:
@@ -57863,7 +58054,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
operationId: security-and-analysis
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis
parameters:
- name: User-Agent
in: header
@@ -57913,7 +58104,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-and-analysis
+ subcategory: security_and_analysis
supported-webhook-types:
- repository
- organization
@@ -57930,7 +58121,7 @@ webhooks:
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
operationId: sponsorship/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -57993,7 +58184,7 @@ webhooks:
occurs once the payment is successfully processed.
operationId: sponsorship/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58057,7 +58248,7 @@ webhooks:
to reflect the change when this event occurs.
operationId: sponsorship/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58122,7 +58313,7 @@ webhooks:
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
operationId: sponsorship/pending-cancellation
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58185,7 +58376,7 @@ webhooks:
new tier will become effective on their next billing date.
operationId: sponsorship/pending-tier-change
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58250,7 +58441,7 @@ webhooks:
the beginning of the sponsor's next billing cycle.
operationId: sponsorship/tier-changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58312,7 +58503,7 @@ webhooks:
description: Someone starred a repository.
operationId: star/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
@@ -58376,7 +58567,7 @@ webhooks:
description: Someone unstarred the repository.
operationId: star/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
@@ -58439,7 +58630,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.
operationId: status
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#status
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#status
parameters:
- name: User-Agent
in: header
@@ -58505,7 +58696,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
operationId: team-add
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team-add
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add
parameters:
- name: User-Agent
in: header
@@ -58555,7 +58746,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: team-add
+ subcategory: team_add
supported-webhook-types:
- repository
- organization
@@ -58570,7 +58761,7 @@ webhooks:
description: A team was granted access to a repository.
operationId: team/added-to-repository
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58635,7 +58826,7 @@ webhooks:
description: A team was created.
operationId: team/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58700,7 +58891,7 @@ webhooks:
description: A team was deleted.
operationId: team/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58765,7 +58956,7 @@ webhooks:
description: The name, description, or visibility of a team was changed.
operationId: team/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58830,7 +59021,7 @@ webhooks:
description: A team's access to a repository was removed.
operationId: team/removed-from-repository
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58894,7 +59085,7 @@ webhooks:
description: Someone started watching the repository.
operationId: watch/started
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#watch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch
parameters:
- name: User-Agent
in: header
@@ -58959,7 +59150,7 @@ webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: workflow-dispatch
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-dispatch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch
parameters:
- name: User-Agent
in: header
@@ -59009,7 +59200,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-dispatch
+ subcategory: workflow_dispatch
supported-webhook-types:
- app
workflow-job-completed:
@@ -59025,7 +59216,7 @@ webhooks:
unsuccessful.
operationId: workflow-job/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59075,7 +59266,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59092,7 +59283,7 @@ webhooks:
description: A job in a workflow run started processing on a runner.
operationId: workflow-job/in-progress
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59142,7 +59333,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59159,7 +59350,7 @@ webhooks:
description: A job in a workflow run was created.
operationId: workflow-job/queued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59209,7 +59400,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59226,7 +59417,7 @@ webhooks:
description: A job in a workflow run was created and is waiting for approvals.
operationId: workflow-job/waiting
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59276,7 +59467,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59294,7 +59485,7 @@ webhooks:
is completed, regardless of whether the workflow was successful or unsuccessful.
operationId: workflow-run/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59344,7 +59535,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59361,7 +59552,7 @@ webhooks:
description: A workflow run started processing on a runner.
operationId: workflow-run/in-progress
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59411,7 +59602,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59428,7 +59619,7 @@ webhooks:
description: A workflow run was triggered.
operationId: workflow-run/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59478,7 +59669,7 @@ webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59986,6 +60177,7 @@ components:
type:
- array
- 'null'
+ description: The users who contributed to the advisory.
readOnly: true
items:
type: object
@@ -60859,7 +61051,7 @@ components:
type: string
format: uri
examples:
- - https://api.github.com/installations/1/access_tokens
+ - https://api.github.com/app/installations/1/access_tokens
repositories_url:
type: string
format: uri
@@ -61315,6 +61507,7 @@ components:
description: Whether downloads are enabled.
default: true
type: boolean
+ deprecated: true
examples:
- true
has_discussions:
@@ -61978,6 +62171,522 @@ components:
- created_at
- updated_at
- expires_at
+ simple-classroom-repository:
+ title: Simple Classroom Repository
+ description: A GitHub repository view for Classroom
+ type: object
+ properties:
+ id:
+ type: integer
+ description: A unique identifier of the repository.
+ examples:
+ - 1296269
+ full_name:
+ type: string
+ description: The full, globally unique name of the repository.
+ examples:
+ - octocat/Hello-World
+ html_url:
+ type: string
+ format: uri
+ description: The URL to view the repository on GitHub.com.
+ examples:
+ - https://github.com/octocat/Hello-World
+ node_id:
+ type: string
+ description: The GraphQL identifier of the repository.
+ examples:
+ - MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ private:
+ type: boolean
+ description: Whether the repository is private.
+ default_branch:
+ type: string
+ description: The default branch for the repository.
+ examples:
+ - main
+ required:
+ - id
+ - full_name
+ - html_url
+ - node_id
+ - private
+ - default_branch
+ simple-classroom-organization:
+ title: Organization Simple for Classroom
+ description: A GitHub organization.
+ type: object
+ properties:
+ id:
+ type: integer
+ examples:
+ - 1
+ login:
+ type: string
+ examples:
+ - github
+ node_id:
+ type: string
+ examples:
+ - MDEyOk9yZ2FuaXphdGlvbjE=
+ html_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/github
+ name:
+ type:
+ - string
+ - 'null'
+ examples:
+ - Github - Code thigns happen here
+ avatar_url:
+ type: string
+ examples:
+ - https://github.com/images/error/octocat_happy.gif
+ required:
+ - id
+ - login
+ - node_id
+ - html_url
+ - name
+ - avatar_url
+ classroom:
+ title: Classroom
+ description: A GitHub Classroom classroom
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the classroom.
+ type: integer
+ examples:
+ - 42
+ name:
+ description: The name of the classroom.
+ type: string
+ examples:
+ - Programming Elixir
+ archived:
+ description: Whether classroom is archived.
+ type: boolean
+ examples:
+ - false
+ organization:
+ "$ref": "#/components/schemas/simple-classroom-organization"
+ url:
+ description: The URL of the classroom on GitHub Classroom.
+ type: string
+ examples:
+ - https://classroom.github.com/classrooms/1-programming-elixir
+ required:
+ - id
+ - name
+ - archived
+ - organization
+ - url
+ classroom-assignment:
+ title: Classroom Assignment
+ description: A GitHub Classroom assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ examples:
+ - 42
+ public_repo:
+ description: Whether an accepted assignment creates a public repository.
+ type: boolean
+ examples:
+ - true
+ title:
+ description: Assignment title.
+ type: string
+ examples:
+ - Intro to Binaries
+ type:
+ description: Whether it's a group assignment or individual assignment.
+ type: string
+ enum:
+ - individual
+ - group
+ examples:
+ - individual
+ invite_link:
+ description: The link that a student can use to accept the assignment.
+ type: string
+ examples:
+ - https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled:
+ description: Whether the invitation link is enabled. Visiting an enabled
+ invitation link will accept the assignment.
+ type: boolean
+ examples:
+ - true
+ slug:
+ description: Sluggified name of the assignment.
+ type: string
+ examples:
+ - intro-to-binaries
+ students_are_repo_admins:
+ description: Whether students are admins on created repository when a student
+ accepts the assignment.
+ type: boolean
+ examples:
+ - true
+ feedback_pull_requests_enabled:
+ description: Whether feedback pull request will be created when a student
+ accepts the assignment.
+ type: boolean
+ examples:
+ - true
+ max_teams:
+ description: The maximum allowable teams for the assignment.
+ type:
+ - integer
+ - 'null'
+ examples:
+ - 0
+ max_members:
+ description: The maximum allowable members per team.
+ type:
+ - integer
+ - 'null'
+ examples:
+ - 0
+ editor:
+ description: The selected editor for the assignment.
+ type: string
+ examples:
+ - codespaces
+ accepted:
+ description: The number of students that have accepted the assignment.
+ type: integer
+ examples:
+ - 25
+ submitted:
+ description: The number of students that have submitted the assignment.
+ type: integer
+ examples:
+ - 10
+ passing:
+ description: The number of students that have passed the assignment.
+ type: integer
+ examples:
+ - 10
+ language:
+ description: The programming language used in the assignment.
+ type: string
+ examples:
+ - elixir
+ deadline:
+ description: The time at which the assignment is due.
+ type:
+ - string
+ - 'null'
+ format: date-time
+ examples:
+ - '2011-01-26T19:06:43Z'
+ starter_code_repository:
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ classroom:
+ "$ref": "#/components/schemas/classroom"
+ required:
+ - id
+ - public_repo
+ - title
+ - type
+ - invite_link
+ - invitations_enabled
+ - slug
+ - students_are_repo_admins
+ - feedback_pull_requests_enabled
+ - max_teams
+ - max_members
+ - editor
+ - accepted
+ - submitted
+ - passing
+ - language
+ - deadline
+ - starter_code_repository
+ - classroom
+ simple-classroom-user:
+ title: Simple Classroom User
+ description: A GitHub user simplified for Classroom.
+ type: object
+ properties:
+ id:
+ type: integer
+ examples:
+ - 1
+ login:
+ type: string
+ examples:
+ - octocat
+ avatar_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/images/error/octocat_happy.gif
+ html_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/octocat
+ required:
+ - id
+ - login
+ - avatar_url
+ - html_url
+ simple-classroom:
+ title: Simple Classroom
+ description: A GitHub Classroom classroom
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the classroom.
+ type: integer
+ examples:
+ - 42
+ name:
+ description: The name of the classroom.
+ type: string
+ examples:
+ - Programming Elixir
+ archived:
+ description: Returns whether classroom is archived or not.
+ type: boolean
+ examples:
+ - false
+ url:
+ description: The url of the classroom on GitHub Classroom.
+ type: string
+ examples:
+ - https://classroom.github.com/classrooms/1-programming-elixir
+ required:
+ - id
+ - name
+ - archived
+ - url
+ simple-classroom-assignment:
+ title: Simple Classroom Assignment
+ description: A GitHub Classroom assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ examples:
+ - 42
+ public_repo:
+ description: Whether an accepted assignment creates a public repository.
+ type: boolean
+ examples:
+ - true
+ title:
+ description: Assignment title.
+ type: string
+ examples:
+ - Intro to Binaries
+ type:
+ description: Whether it's a Group Assignment or Individual Assignment.
+ type: string
+ enum:
+ - individual
+ - group
+ examples:
+ - individual
+ invite_link:
+ description: The link that a student can use to accept the assignment.
+ type: string
+ examples:
+ - https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled:
+ description: Whether the invitation link is enabled. Visiting an enabled
+ invitation link will accept the assignment.
+ type: boolean
+ examples:
+ - true
+ slug:
+ description: Sluggified name of the assignment.
+ type: string
+ examples:
+ - intro-to-binaries
+ students_are_repo_admins:
+ description: Whether students are admins on created repository on accepted
+ assignment.
+ type: boolean
+ examples:
+ - true
+ feedback_pull_requests_enabled:
+ description: Whether feedback pull request will be created on assignment
+ acceptance.
+ type: boolean
+ examples:
+ - true
+ max_teams:
+ description: The maximum allowable teams for the assignment.
+ type:
+ - integer
+ - 'null'
+ examples:
+ - 0
+ max_members:
+ description: The maximum allowable members per team.
+ type:
+ - integer
+ - 'null'
+ examples:
+ - 0
+ editor:
+ description: The selected editor for the assignment.
+ type: string
+ examples:
+ - codespaces
+ accepted:
+ description: The number of students that have accepted the assignment.
+ type: integer
+ examples:
+ - 25
+ submitted:
+ description: The number of students that have submitted the assignment.
+ type: integer
+ examples:
+ - 10
+ passing:
+ description: The number of students that have passed the assignment.
+ type: integer
+ examples:
+ - 10
+ language:
+ description: The programming language used in the assignment.
+ type: string
+ examples:
+ - elixir
+ deadline:
+ description: The time at which the assignment is due.
+ type:
+ - string
+ - 'null'
+ format: date-time
+ examples:
+ - '2011-01-26T19:06:43Z'
+ classroom:
+ "$ref": "#/components/schemas/simple-classroom"
+ required:
+ - id
+ - public_repo
+ - title
+ - type
+ - invite_link
+ - invitations_enabled
+ - slug
+ - students_are_repo_admins
+ - feedback_pull_requests_enabled
+ - editor
+ - accepted
+ - submitted
+ - passing
+ - language
+ - deadline
+ - classroom
+ classroom-accepted-assignment:
+ title: Classroom Accepted Assignment
+ description: A GitHub Classroom accepted assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ examples:
+ - 42
+ submitted:
+ description: Whether an accepted assignment has been submitted.
+ type: boolean
+ examples:
+ - true
+ passing:
+ description: Whether a submission passed.
+ type: boolean
+ examples:
+ - true
+ commit_count:
+ description: Count of student commits.
+ type: integer
+ examples:
+ - 5
+ grade:
+ description: Most recent grade.
+ type: string
+ examples:
+ - 10/10
+ students:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom-user"
+ repository:
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ assignment:
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ required:
+ - id
+ - submitted
+ - passing
+ - commit_count
+ - grade
+ - students
+ - repository
+ - assignment
+ classroom-assignment-grade:
+ title: Classroom Assignment Grade
+ description: Grade for a student or groups GitHub Classroom assignment
+ type: object
+ properties:
+ assignment_name:
+ description: Name of the assignment
+ type: string
+ assignment_url:
+ description: URL of the assignment
+ type: string
+ starter_code_url:
+ description: URL of the starter code for the assignment
+ type: string
+ github_username:
+ description: GitHub username of the student
+ type: string
+ roster_identifier:
+ description: Roster identifier of the student
+ type: string
+ student_repository_name:
+ description: Name of the student's assignment repository
+ type: string
+ student_repository_url:
+ description: URL of the student's assignment repository
+ type: string
+ submission_timestamp:
+ description: Timestamp of the student's assignment submission
+ type: string
+ points_awarded:
+ description: Number of points awarded to the student
+ type: integer
+ points_available:
+ description: Number of points available for the assignment
+ type: integer
+ group_name:
+ description: If a group assignment, name of the group the student is in
+ type: string
+ required:
+ - assignment_name
+ - assignment_url
+ - starter_code_url
+ - github_username
+ - roster_identifier
+ - student_repository_name
+ - student_repository_url
+ - submission_timestamp
+ - points_awarded
+ - points_available
code-of-conduct:
title: Code Of Conduct
description: Code Of Conduct
@@ -75658,8 +76367,6 @@ components:
- versionInfo
- downloadLocation
- filesAnalyzed
- - licenseConcluded
- - licenseDeclared
- supplier
required:
- SPDXID
@@ -83594,8 +84301,10 @@ components:
- id
simple-installation:
title: Simple Installation
- description: The GitHub App installation. This property is included when the
- event is configured for and sent to a GitHub App.
+ description: |-
+ The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
+ for and sent to a GitHub App. For more information,
+ see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)."
type: object
properties:
id:
@@ -83611,6 +84320,1020 @@ components:
required:
- id
- node_id
+ organization-simple-webhooks:
+ title: Organization Simple
+ description: |-
+ A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
+ organization, or when the event occurs from activity in a repository owned by an organization.
+ type: object
+ properties:
+ login:
+ type: string
+ examples:
+ - github
+ id:
+ type: integer
+ examples:
+ - 1
+ node_id:
+ type: string
+ examples:
+ - MDEyOk9yZ2FuaXphdGlvbjE=
+ url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/orgs/github
+ repos_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/orgs/github/repos
+ events_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/orgs/github/events
+ hooks_url:
+ type: string
+ examples:
+ - https://api.github.com/orgs/github/hooks
+ issues_url:
+ type: string
+ examples:
+ - https://api.github.com/orgs/github/issues
+ members_url:
+ type: string
+ examples:
+ - https://api.github.com/orgs/github/members{/member}
+ public_members_url:
+ type: string
+ examples:
+ - https://api.github.com/orgs/github/public_members{/member}
+ avatar_url:
+ type: string
+ examples:
+ - https://github.com/images/error/octocat_happy.gif
+ description:
+ type:
+ - string
+ - 'null'
+ examples:
+ - A great organization
+ required:
+ - login
+ - url
+ - id
+ - node_id
+ - repos_url
+ - events_url
+ - hooks_url
+ - issues_url
+ - members_url
+ - public_members_url
+ - avatar_url
+ - description
+ repository-webhooks:
+ title: Repository
+ description: |-
+ The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ when the event occurs from activity in a repository.
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository
+ type: integer
+ examples:
+ - 42
+ node_id:
+ type: string
+ examples:
+ - MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ name:
+ description: The name of the repository.
+ type: string
+ examples:
+ - Team Environment
+ full_name:
+ type: string
+ examples:
+ - octocat/Hello-World
+ license:
+ anyOf:
+ - type: 'null'
+ - "$ref": "#/components/schemas/license-simple"
+ organization:
+ anyOf:
+ - type: 'null'
+ - "$ref": "#/components/schemas/simple-user"
+ forks:
+ type: integer
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ required:
+ - admin
+ - pull
+ - push
+ owner:
+ "$ref": "#/components/schemas/simple-user"
+ private:
+ description: Whether the repository is private or public.
+ default: false
+ type: boolean
+ html_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/octocat/Hello-World
+ description:
+ type:
+ - string
+ - 'null'
+ examples:
+ - This your first repo!
+ fork:
+ type: boolean
+ url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/repos/octocat/Hello-World
+ archive_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
+ assignees_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/assignees{/user}
+ blobs_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
+ branches_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/branches{/branch}
+ collaborators_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
+ comments_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/comments{/number}
+ commits_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/commits{/sha}
+ compare_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
+ contents_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/contents/{+path}
+ contributors_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/contributors
+ deployments_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/deployments
+ downloads_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/downloads
+ events_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/events
+ forks_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/forks
+ git_commits_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
+ git_refs_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
+ git_tags_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
+ git_url:
+ type: string
+ examples:
+ - git:github.com/octocat/Hello-World.git
+ issue_comment_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
+ issue_events_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
+ issues_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/issues{/number}
+ keys_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
+ labels_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/labels{/name}
+ languages_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/languages
+ merges_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/merges
+ milestones_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/milestones{/number}
+ notifications_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
+ pulls_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/pulls{/number}
+ releases_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/releases{/id}
+ ssh_url:
+ type: string
+ examples:
+ - git@github.com:octocat/Hello-World.git
+ stargazers_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/stargazers
+ statuses_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
+ subscribers_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/subscribers
+ subscription_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/subscription
+ tags_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/tags
+ teams_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/teams
+ trees_url:
+ type: string
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
+ clone_url:
+ type: string
+ examples:
+ - https://github.com/octocat/Hello-World.git
+ mirror_url:
+ type:
+ - string
+ - 'null'
+ format: uri
+ examples:
+ - git:git.example.com/octocat/Hello-World
+ hooks_url:
+ type: string
+ format: uri
+ examples:
+ - http://api.github.com/repos/octocat/Hello-World/hooks
+ svn_url:
+ type: string
+ format: uri
+ examples:
+ - https://svn.github.com/octocat/Hello-World
+ homepage:
+ type:
+ - string
+ - 'null'
+ format: uri
+ examples:
+ - https://github.com
+ language:
+ type:
+ - string
+ - 'null'
+ forks_count:
+ type: integer
+ examples:
+ - 9
+ stargazers_count:
+ type: integer
+ examples:
+ - 80
+ watchers_count:
+ type: integer
+ examples:
+ - 80
+ size:
+ description: The size of the repository. Size is calculated hourly. When
+ a repository is initially created, the size is 0.
+ type: integer
+ examples:
+ - 108
+ default_branch:
+ description: The default branch of the repository.
+ type: string
+ examples:
+ - master
+ open_issues_count:
+ type: integer
+ examples:
+ - 0
+ is_template:
+ description: Whether this repository acts as a template that can be used
+ to generate new repositories.
+ default: false
+ type: boolean
+ examples:
+ - true
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ description: Whether issues are enabled.
+ default: true
+ type: boolean
+ examples:
+ - true
+ has_projects:
+ description: Whether projects are enabled.
+ default: true
+ type: boolean
+ examples:
+ - true
+ has_wiki:
+ description: Whether the wiki is enabled.
+ default: true
+ type: boolean
+ examples:
+ - true
+ has_pages:
+ type: boolean
+ has_downloads:
+ description: Whether downloads are enabled.
+ default: true
+ type: boolean
+ examples:
+ - true
+ has_discussions:
+ description: Whether discussions are enabled.
+ default: false
+ type: boolean
+ examples:
+ - true
+ archived:
+ description: Whether the repository is archived.
+ default: false
+ type: boolean
+ disabled:
+ type: boolean
+ description: Returns whether or not this repository disabled.
+ visibility:
+ description: 'The repository visibility: public, private, or internal.'
+ default: public
+ type: string
+ pushed_at:
+ type:
+ - string
+ - 'null'
+ format: date-time
+ examples:
+ - '2011-01-26T19:06:43Z'
+ created_at:
+ type:
+ - string
+ - 'null'
+ format: date-time
+ examples:
+ - '2011-01-26T19:01:12Z'
+ updated_at:
+ type:
+ - string
+ - 'null'
+ format: date-time
+ examples:
+ - '2011-01-26T19:14:43Z'
+ allow_rebase_merge:
+ description: Whether to allow rebase merges for pull requests.
+ default: true
+ type: boolean
+ examples:
+ - true
+ template_repository:
+ type:
+ - object
+ - 'null'
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ full_name:
+ type: string
+ owner:
+ type: object
+ properties:
+ login:
+ type: string
+ id:
+ type: integer
+ node_id:
+ type: string
+ avatar_url:
+ type: string
+ gravatar_id:
+ type: string
+ url:
+ type: string
+ html_url:
+ type: string
+ followers_url:
+ type: string
+ following_url:
+ type: string
+ gists_url:
+ type: string
+ starred_url:
+ type: string
+ subscriptions_url:
+ type: string
+ organizations_url:
+ type: string
+ repos_url:
+ type: string
+ events_url:
+ type: string
+ received_events_url:
+ type: string
+ type:
+ type: string
+ site_admin:
+ type: boolean
+ private:
+ type: boolean
+ html_url:
+ type: string
+ description:
+ type: string
+ fork:
+ type: boolean
+ url:
+ type: string
+ archive_url:
+ type: string
+ assignees_url:
+ type: string
+ blobs_url:
+ type: string
+ branches_url:
+ type: string
+ collaborators_url:
+ type: string
+ comments_url:
+ type: string
+ commits_url:
+ type: string
+ compare_url:
+ type: string
+ contents_url:
+ type: string
+ contributors_url:
+ type: string
+ deployments_url:
+ type: string
+ downloads_url:
+ type: string
+ events_url:
+ type: string
+ forks_url:
+ type: string
+ git_commits_url:
+ type: string
+ git_refs_url:
+ type: string
+ git_tags_url:
+ type: string
+ git_url:
+ type: string
+ issue_comment_url:
+ type: string
+ issue_events_url:
+ type: string
+ issues_url:
+ type: string
+ keys_url:
+ type: string
+ labels_url:
+ type: string
+ languages_url:
+ type: string
+ merges_url:
+ type: string
+ milestones_url:
+ type: string
+ notifications_url:
+ type: string
+ pulls_url:
+ type: string
+ releases_url:
+ type: string
+ ssh_url:
+ type: string
+ stargazers_url:
+ type: string
+ statuses_url:
+ type: string
+ subscribers_url:
+ type: string
+ subscription_url:
+ type: string
+ tags_url:
+ type: string
+ teams_url:
+ type: string
+ trees_url:
+ type: string
+ clone_url:
+ type: string
+ mirror_url:
+ type: string
+ hooks_url:
+ type: string
+ svn_url:
+ type: string
+ homepage:
+ type: string
+ language:
+ type: string
+ forks_count:
+ type: integer
+ stargazers_count:
+ type: integer
+ watchers_count:
+ type: integer
+ size:
+ type: integer
+ default_branch:
+ type: string
+ open_issues_count:
+ type: integer
+ is_template:
+ type: boolean
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ type: boolean
+ has_projects:
+ type: boolean
+ has_wiki:
+ type: boolean
+ has_pages:
+ type: boolean
+ has_downloads:
+ type: boolean
+ archived:
+ type: boolean
+ disabled:
+ type: boolean
+ visibility:
+ type: string
+ pushed_at:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ maintain:
+ type: boolean
+ push:
+ type: boolean
+ triage:
+ type: boolean
+ pull:
+ type: boolean
+ allow_rebase_merge:
+ type: boolean
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ type: boolean
+ allow_auto_merge:
+ type: boolean
+ delete_branch_on_merge:
+ type: boolean
+ allow_update_branch:
+ type: boolean
+ use_squash_pr_title_as_default:
+ type: boolean
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ description: Whether to allow squash merges for pull requests.
+ default: true
+ type: boolean
+ examples:
+ - true
+ allow_auto_merge:
+ description: Whether to allow Auto-merge to be used on pull requests.
+ default: false
+ type: boolean
+ examples:
+ - false
+ delete_branch_on_merge:
+ description: Whether to delete head branches when pull requests are merged
+ default: false
+ type: boolean
+ examples:
+ - false
+ 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
+ examples:
+ - false
+ use_squash_pr_title_as_default:
+ type: boolean
+ 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
+ deprecated: true
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ description: Whether to allow merge commits for pull requests.
+ default: true
+ type: boolean
+ examples:
+ - true
+ allow_forking:
+ description: Whether to allow forking this repo
+ type: boolean
+ web_commit_signoff_required:
+ description: Whether to require contributors to sign off on web-based commits
+ default: false
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ open_issues:
+ type: integer
+ watchers:
+ type: integer
+ master_branch:
+ type: string
+ starred_at:
+ type: string
+ examples:
+ - '"2020-07-09T00:17:42Z"'
+ anonymous_access_enabled:
+ type: boolean
+ description: Whether anonymous git access is enabled for this repository
+ required:
+ - archive_url
+ - assignees_url
+ - blobs_url
+ - branches_url
+ - collaborators_url
+ - comments_url
+ - commits_url
+ - compare_url
+ - contents_url
+ - contributors_url
+ - deployments_url
+ - description
+ - downloads_url
+ - events_url
+ - fork
+ - forks_url
+ - full_name
+ - git_commits_url
+ - git_refs_url
+ - git_tags_url
+ - hooks_url
+ - html_url
+ - id
+ - node_id
+ - issue_comment_url
+ - issue_events_url
+ - issues_url
+ - keys_url
+ - labels_url
+ - languages_url
+ - merges_url
+ - milestones_url
+ - name
+ - notifications_url
+ - owner
+ - private
+ - pulls_url
+ - releases_url
+ - stargazers_url
+ - statuses_url
+ - subscribers_url
+ - subscription_url
+ - tags_url
+ - teams_url
+ - trees_url
+ - url
+ - clone_url
+ - default_branch
+ - forks
+ - forks_count
+ - git_url
+ - has_downloads
+ - has_issues
+ - has_projects
+ - has_wiki
+ - has_pages
+ - homepage
+ - language
+ - archived
+ - disabled
+ - mirror_url
+ - open_issues
+ - open_issues_count
+ - license
+ - pushed_at
+ - size
+ - ssh_url
+ - stargazers_count
+ - svn_url
+ - watchers
+ - watchers_count
+ - created_at
+ - updated_at
+ simple-user-webhooks:
+ title: Simple User
+ description: The GitHub user that triggered the event. This property is included
+ in every webhook payload.
+ type: object
+ properties:
+ name:
+ type:
+ - string
+ - 'null'
+ email:
+ type:
+ - string
+ - 'null'
+ login:
+ type: string
+ examples:
+ - octocat
+ id:
+ type: integer
+ examples:
+ - 1
+ node_id:
+ type: string
+ examples:
+ - MDQ6VXNlcjE=
+ avatar_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/images/error/octocat_happy.gif
+ gravatar_id:
+ type:
+ - string
+ - 'null'
+ examples:
+ - 41d064eb2195891e12d0413f63227ea7
+ url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat
+ html_url:
+ type: string
+ format: uri
+ examples:
+ - https://github.com/octocat
+ followers_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat/followers
+ following_url:
+ type: string
+ examples:
+ - https://api.github.com/users/octocat/following{/other_user}
+ gists_url:
+ type: string
+ examples:
+ - https://api.github.com/users/octocat/gists{/gist_id}
+ starred_url:
+ type: string
+ examples:
+ - https://api.github.com/users/octocat/starred{/owner}{/repo}
+ subscriptions_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat/subscriptions
+ organizations_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat/orgs
+ repos_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat/repos
+ events_url:
+ type: string
+ examples:
+ - https://api.github.com/users/octocat/events{/privacy}
+ received_events_url:
+ type: string
+ format: uri
+ examples:
+ - https://api.github.com/users/octocat/received_events
+ type:
+ type: string
+ examples:
+ - User
+ site_admin:
+ type: boolean
+ starred_at:
+ type: string
+ examples:
+ - '"2020-07-09T00:17:55Z"'
+ required:
+ - avatar_url
+ - events_url
+ - followers_url
+ - following_url
+ - gists_url
+ - gravatar_id
+ - html_url
+ - id
+ - node_id
+ - login
+ - organizations_url
+ - received_events_url
+ - repos_url
+ - site_admin
+ - starred_url
+ - subscriptions_url
+ - type
+ - url
simple-check-suite:
description: A suite of checks performed on the code of a given code change
type: object
@@ -84500,11 +86223,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -84522,11 +86245,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -84544,9 +86267,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -84678,7 +86401,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -84697,9 +86420,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -84831,7 +86554,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -84921,9 +86644,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -85055,7 +86778,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -85074,11 +86797,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -85107,11 +86830,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -85140,9 +86863,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_action:
description: The action requested by the user.
type: object
@@ -85152,7 +86875,7 @@ components:
user.
type: string
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_run
@@ -85182,11 +86905,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -85805,11 +87528,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -86417,11 +88140,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -87023,11 +88746,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -87276,16 +88999,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87557,16 +89280,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87781,16 +89504,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88066,16 +89789,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88283,7 +90006,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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
@@ -88292,9 +90015,9 @@ components:
- string
- 'null'
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88470,16 +90193,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88676,11 +90399,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -88703,7 +90426,7 @@ components:
description: The name of the repository's default branch (usually `main`).
type: string
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher_type:
description: The pusher type for the event. Can be either `user` or a deploy
key.
@@ -88719,9 +90442,9 @@ components:
- tag
- branch
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- ref_type
@@ -88739,7 +90462,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher_type:
description: The pusher type for the event. Can be either `user` or a deploy
key.
@@ -88755,9 +90478,9 @@ components:
- tag
- branch
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- ref_type
@@ -88777,13 +90500,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88802,13 +90525,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88827,13 +90550,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88852,13 +90575,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88877,13 +90600,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88902,13 +90625,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88927,13 +90650,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88988,11 +90711,11 @@ components:
- created_at
- read_only
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- key
@@ -89047,11 +90770,11 @@ components:
- created_at
- read_only
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- key
@@ -89558,11 +91281,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type:
@@ -90241,13 +91964,13 @@ components:
items:
"$ref": "#/components/schemas/pull-request"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
webhook-deployment-review-approved:
type: object
properties:
@@ -90301,9 +92024,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
reviewers:
type: array
items:
@@ -90383,7 +92106,7 @@ components:
enum:
- User
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -91108,9 +92831,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
reviewers:
type: array
items:
@@ -91190,7 +92913,7 @@ components:
enum:
- User
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -91876,9 +93599,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requestor:
title: User
type:
@@ -92027,7 +93750,7 @@ components:
- User
- Team
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -93740,11 +95463,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type:
@@ -94570,11 +96293,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94640,11 +96363,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -94666,11 +96389,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94848,11 +96571,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -95031,11 +96754,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -95226,11 +96949,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -95686,11 +97409,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95711,11 +97434,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95753,11 +97476,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95811,11 +97534,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95837,11 +97560,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95862,11 +97585,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95887,11 +97610,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95911,7 +97634,7 @@ components:
new_discussion:
"$ref": "#/components/schemas/discussion"
new_repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
required:
- new_discussion
- new_repository
@@ -95922,11 +97645,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -96101,11 +97824,11 @@ components:
- updated_at
- body
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -96159,11 +97882,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -96185,11 +97908,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -96210,11 +97933,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -96904,11 +98627,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- forkee
- repository
@@ -96926,11 +98649,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- sender
@@ -96943,7 +98666,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pages:
description: The pages that were updated.
type: array
@@ -96982,9 +98705,9 @@ components:
- sha
- html_url
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- pages
- repository
@@ -97002,7 +98725,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -97029,7 +98752,7 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
title: User
type:
@@ -97100,7 +98823,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97118,7 +98841,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -97145,12 +98868,12 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
type:
- 'null'
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97168,7 +98891,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -97195,12 +98918,12 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
type:
- 'null'
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97218,7 +98941,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories_added:
description: An array of repository objects, which were added to the installation.
type: array
@@ -97265,7 +98988,7 @@ components:
description: Whether the repository is private or public.
type: boolean
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_selection:
description: Describe whether all repositories have been selected or there's
a selection involved
@@ -97343,7 +99066,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97365,7 +99088,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories_added:
description: An array of repository objects, which were added to the installation.
type: array
@@ -97418,7 +99141,7 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_selection:
description: Describe whether all repositories have been selected or there's
a selection involved
@@ -97496,7 +99219,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97518,7 +99241,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -97545,12 +99268,12 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
type:
- 'null'
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97668,11 +99391,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
target_type:
type: string
required:
@@ -97694,7 +99417,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -97721,12 +99444,12 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
type:
- 'null'
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -99071,11 +100794,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -100419,11 +102142,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -101782,11 +103505,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -102795,11 +104518,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -103882,11 +105605,11 @@ components:
- state
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -104817,11 +106540,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -106174,11 +107897,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -107169,11 +108892,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -108144,11 +109867,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -109227,11 +110950,11 @@ components:
- locked
- active_lock_reason
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -110580,11 +112303,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -112899,11 +114622,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -113833,11 +115556,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -114915,11 +116638,11 @@ components:
required:
- state
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -117235,11 +118958,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -118248,11 +119971,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -119222,11 +120945,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -120295,11 +122018,11 @@ components:
- locked
- active_lock_reason
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -121229,11 +122952,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -121285,11 +123008,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -121340,11 +123063,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -121427,11 +123150,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -121602,7 +123325,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -121688,9 +123411,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -121861,7 +123584,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -121950,9 +123673,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -122123,7 +123846,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -122210,9 +123933,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -122324,7 +124047,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -122410,9 +124133,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -122583,7 +124306,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -122669,9 +124392,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -122773,11 +124496,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- member
@@ -122889,11 +124612,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -122982,11 +124705,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- member
@@ -123074,9 +124797,9 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
scope:
description: The scope of the membership. Currently, can only be `team`.
type: string
@@ -123355,9 +125078,9 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
scope:
description: The scope of the membership. Currently, can only be `team`.
type: string
@@ -123567,11 +125290,11 @@ components:
merge_group:
"$ref": "#/components/schemas/merge-group"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- merge_group
@@ -123596,11 +125319,11 @@ components:
merge_group:
"$ref": "#/components/schemas/merge-group"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- merge_group
@@ -123724,13 +125447,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
anyOf:
- type: 'null'
- - "$ref": "#/components/schemas/repository"
+ - "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- hook_id
@@ -123889,11 +125612,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -124052,11 +125775,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -124216,11 +125939,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -124411,11 +126134,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -124575,11 +126298,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -124667,11 +126390,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- blocked_user
@@ -124759,11 +126482,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- blocked_user
@@ -124873,11 +126596,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- organization
@@ -124986,11 +126709,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- membership
@@ -125127,11 +126850,11 @@ components:
- team_count
- invitation_teams_url
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
user:
title: User
type:
@@ -125310,11 +127033,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- membership
@@ -125432,11 +127155,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- organization
@@ -125487,7 +127210,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
package:
description: Information about the package.
type: object
@@ -126071,9 +127794,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- package
@@ -126091,7 +127814,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
package:
description: Information about the package.
type: object
@@ -126520,9 +128243,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- package
@@ -126646,11 +128369,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- id
- build
@@ -126667,9 +128390,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -126689,9 +128412,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -126711,9 +128434,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -126733,9 +128456,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -126822,11 +128545,11 @@ components:
description: The ID of the webhook that triggered the ping.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
zen:
description: Random string of GitHub zen.
type: string
@@ -126865,7 +128588,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -126988,9 +128711,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -127009,7 +128732,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -127132,9 +128855,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -127152,7 +128875,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -127280,9 +129003,9 @@ components:
repository:
anyOf:
- type: 'null'
- - "$ref": "#/components/schemas/repository"
+ - "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -127314,7 +129037,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -127437,9 +129160,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -127470,7 +129193,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
allOf:
- title: Project Card
@@ -127666,9 +129389,9 @@ components:
required:
- after_id
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -127686,7 +129409,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -127813,9 +129536,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -127833,7 +129556,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -127875,9 +129598,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -127894,7 +129617,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -127938,9 +129661,9 @@ components:
repository:
anyOf:
- type: 'null'
- - "$ref": "#/components/schemas/repository"
+ - "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -127967,7 +129690,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -128009,9 +129732,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -128029,7 +129752,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -128071,9 +129794,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -128091,7 +129814,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -128218,9 +129941,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -128238,7 +129961,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -128367,9 +130090,9 @@ components:
repository:
anyOf:
- type: 'null'
- - "$ref": "#/components/schemas/repository"
+ - "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -128407,7 +130130,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -128534,9 +130257,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -128553,7 +130276,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -128680,9 +130403,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -128698,11 +130421,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -128719,11 +130442,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -128740,11 +130463,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -128800,11 +130523,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -128838,11 +130561,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -128872,11 +130595,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -128894,11 +130617,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -128915,11 +130638,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -128964,11 +130687,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -128999,11 +130722,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -129037,11 +130760,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -129059,11 +130782,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -129078,11 +130801,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- repository
- sender
@@ -129171,7 +130894,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -131479,9 +133202,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -131504,7 +133227,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -133807,9 +135530,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -133832,7 +135555,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -136136,9 +137859,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -136161,7 +137884,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -136226,9 +137949,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -136251,7 +137974,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -136316,9 +138039,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -136341,7 +138064,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -138634,9 +140357,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -138657,7 +140380,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -140951,9 +142674,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -141019,7 +142742,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -141084,9 +142807,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -141108,7 +142831,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -143400,9 +145123,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -143458,7 +145181,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -145767,9 +147490,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -145792,7 +147515,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -148099,9 +149822,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -148124,7 +149847,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -150417,9 +152140,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -150441,7 +152164,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -150506,9 +152229,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -150531,7 +152254,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -150596,9 +152319,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -150621,7 +152344,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -150686,9 +152409,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -150997,7 +152720,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -153192,9 +154915,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -153501,7 +155224,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -155684,9 +157407,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -156005,7 +157728,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -158189,9 +159912,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -158212,7 +159935,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -160410,7 +162133,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -160563,7 +162286,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- review
@@ -160595,7 +162318,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -162676,7 +164399,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -162826,7 +164549,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -162851,7 +164574,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -165151,7 +166874,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_reviewer:
title: User
type:
@@ -165222,7 +166945,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_reviewer
- action
@@ -165244,7 +166967,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -167553,7 +169276,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_team:
title: Team
description: Groups of organization members that gives permissions on
@@ -167666,7 +169389,7 @@ components:
- repositories_url
- permission
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_team
- action
@@ -167691,7 +169414,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -169995,7 +171718,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_reviewer:
title: User
type:
@@ -170067,7 +171790,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_reviewer
- action
@@ -170089,7 +171812,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -172384,7 +174107,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_team:
title: Team
description: Groups of organization members that gives permissions on
@@ -172488,7 +174211,7 @@ components:
- name
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_team
- action
@@ -172509,7 +174232,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -174710,7 +176433,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -174860,7 +176583,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- review
@@ -174880,7 +176603,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -176978,9 +178701,9 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
thread:
type: object
properties:
@@ -177301,7 +179024,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -179382,9 +181105,9 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
thread:
type: object
properties:
@@ -179709,7 +181432,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -182004,9 +183727,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -182101,7 +183824,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -184412,9 +186135,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -184469,7 +186192,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -186768,9 +188491,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -186793,7 +188516,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -189083,9 +190806,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -189315,7 +191038,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -189809,7 +191532,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- before
@@ -189835,7 +191558,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
registry_package:
type: object
properties:
@@ -190364,9 +192087,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- registry_package
@@ -190383,7 +192106,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
registry_package:
type: object
properties:
@@ -190741,9 +192464,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- registry_package
@@ -190761,7 +192484,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -191077,9 +192800,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -191098,7 +192821,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -191414,9 +193137,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -191465,7 +193188,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -191781,9 +193504,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -191802,7 +193525,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -192214,9 +193937,9 @@ components:
required:
- prerelease
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -192234,7 +193957,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -192643,9 +194366,9 @@ components:
required:
- published_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -192663,7 +194386,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -192979,9 +194702,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -192999,7 +194722,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -193407,9 +195130,9 @@ components:
required:
- published_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -193427,13 +195150,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_advisory:
"$ref": "#/components/schemas/repository-advisory"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193451,13 +195174,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_advisory:
"$ref": "#/components/schemas/repository-advisory"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193475,11 +195198,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193497,11 +195220,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193519,11 +195242,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193548,11 +195271,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- branch
@@ -193610,11 +195333,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -193629,11 +195352,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
status:
type: string
enum:
@@ -193657,11 +195380,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193679,11 +195402,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -193718,11 +195441,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -193741,13 +195464,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -193765,13 +195488,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -193789,9 +195512,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
changes:
@@ -193889,7 +195612,7 @@ components:
from:
type: string
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -194043,11 +195766,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -194066,11 +195789,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -194247,11 +195970,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194513,11 +196236,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194695,11 +196418,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194883,11 +196606,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194908,11 +196631,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194932,11 +196655,11 @@ components:
location:
"$ref": "#/components/schemas/secret-scanning-location"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- location
- alert
@@ -194967,11 +196690,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -194991,11 +196714,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -195015,11 +196738,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -195037,9 +196760,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -195154,7 +196877,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -195171,9 +196894,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -195288,7 +197011,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -195305,9 +197028,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -195420,7 +197143,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -195441,11 +197164,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
"$ref": "#/components/schemas/full-repository"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- changes
- repository
@@ -195462,11 +197185,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -195710,11 +197433,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -195970,11 +197693,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -196224,11 +197947,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -196520,11 +198243,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -196812,11 +198535,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -197061,11 +198784,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
starred_at:
description: 'The time the star was created. This is a timestamp in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted`
@@ -197091,11 +198814,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
starred_at:
description: 'The time the star was created. This is a timestamp in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted`
@@ -197470,11 +199193,11 @@ components:
name:
type: string
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sha:
description: The Commit SHA.
type: string
@@ -197516,11 +199239,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -197655,7 +199378,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -198116,7 +199839,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -198251,7 +199974,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -198712,7 +200435,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -198848,7 +200571,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -199309,7 +201032,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -199509,7 +201232,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -199970,7 +201693,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -200107,7 +201830,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -200568,7 +202291,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -200704,11 +202427,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -200727,13 +202450,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
type: string
required:
@@ -200755,11 +202478,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
allOf:
- title: Workflow Job
@@ -201030,11 +202753,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
allOf:
- title: Workflow Job
@@ -201331,11 +203054,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
type: object
properties:
@@ -201500,11 +203223,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
type: object
properties:
@@ -201670,11 +203393,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type:
@@ -203126,11 +204849,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type:
@@ -204584,11 +206307,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type:
@@ -205955,7 +207678,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -206001,7 +207724,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -206256,6 +207979,145 @@ components:
site_admin: false
has_multiple_single_files: false
single_file_paths: []
+ classroom-assignment:
+ value:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ deadline: '2011-01-26T19:06:43Z'
+ stater_code_repository:
+ id: 1296269
+ full_name: octocat/Hello-World
+ html_url: https://github.com/octocat/Hello-World
+ node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ private: false
+ default_branch: main
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom-accepted-assignment:
+ value:
+ id: 12,
+ submitted: false,
+ passing: false,
+ commit_count: 5
+ grade: 5/10
+ students:
+ - id: 1
+ login: octocat
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ html_url: https://github.com/octocat
+ repository:
+ id: 1296269
+ full_name: octocat/Hello-World
+ html_url: https://github.com/octocat/Hello-World
+ node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ private: false
+ default_branch: main
+ assignment:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom-assignment-grades:
+ value:
+ - assignment_name: Introduction to Strings
+ assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337
+ starter_code_url: ''
+ github_username: octocat
+ roster_identifier: octocat@github.com
+ student_repository_name: intro-to-strings-1337-octocat
+ student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-octocat
+ submission_timestamp: 2018-11-12 01:02
+ points_awarded: 10
+ points_available: 15
+ group_name: octocat-and-friends
+ - assignment_name: Introduction to Strings
+ assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337
+ starter_code_url: ''
+ github_username: monalisa
+ roster_identifier: monalisa@github.com
+ student_repository_name: intro-to-strings-1337-monalisa
+ student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-monalisa
+ submission_timestamp: 2018-11-12 01:11
+ points_awarded: 15
+ points_available: 15
+ group_name: monalisa-and-friends
+ simple-classroom:
+ value:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom:
+ value:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ organization:
+ id: 1
+ login: programming-elixir
+ node_id: MDEyOk9yZ2FuaXphdGlvbjE=
+ html_url: https://github.com/programming-elixir
+ name: Learn how to build fault tolerant applications
+ avatar_url: https://avatars.githubusercontent.com/u/9919?v=4
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ simple-classroom-assignment:
+ value:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ deadline: '2020-01-11T11:59:22Z'
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
code-of-conduct-simple-items:
value:
- key: citizen_code_of_conduct
@@ -211577,7 +213439,7 @@ components:
type: Organization
site_admin: false
repository_selection: all
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -218274,6 +220136,30 @@ components:
storage_in_bytes: 68719476736
memory_in_bytes: 34359738368
cpus: 8
+ codespaces-default-attributes-for-a-codespace:
+ value:
+ billable_owner:
+ login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ gravatar_id: ''
+ url: https://api.github.com/users/octocat
+ html_url: https://github.com/octocat
+ followers_url: https://api.github.com/users/octocat/followers
+ following_url: https://api.github.com/users/octocat/following{/other_user}
+ gists_url: https://api.github.com/users/octocat/gists{/gist_id}
+ starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
+ subscriptions_url: https://api.github.com/users/octocat/subscriptions
+ organizations_url: https://api.github.com/users/octocat/orgs
+ repos_url: https://api.github.com/users/octocat/repos
+ events_url: https://api.github.com/users/octocat/events{/privacy}
+ received_events_url: https://api.github.com/users/octocat/received_events
+ type: User
+ site_admin: false
+ defaults:
+ location: EastUs
+ devcontainer_path: ".devcontainer/devcontainer.json"
collaborator-items:
value:
- login: octocat
@@ -220394,8 +222280,8 @@ components:
versionInfo: 1.0.0
downloadLocation: NOASSERTION
filesAnalyzed: false
- licenseConcluded: NOASSERTION
- licenseDeclared: NOASSERTION
+ licenseConcluded: MIT
+ licenseDeclared: MIT
dependency-graph-create-snapshot-request:
value:
version: 0
@@ -220714,6 +222600,26 @@ components:
id: 364663
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=
name: main
+ deployment-protection-rules:
+ value:
+ - total_count: 2
+ - custom_deployment_protection_rules:
+ - id: 3
+ node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
+ enabled: true
+ app:
+ id: 1
+ node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy
+ slug: a-custom-app
+ integration_url: https://api.github.com/apps/a-custom-app
+ - id: 4
+ node_id: MDE2OkRlcGxveW1lbnRTdHJ41128
+ enabled: true
+ app:
+ id: 1
+ node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy
+ slug: another-custom-app
+ integration_url: https://api.github.com/apps/another-custom-app
deployment-protection-rule:
value:
id: 3
@@ -228106,7 +230012,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -228150,7 +230056,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -231318,6 +233224,20 @@ components:
required: true
schema:
type: string
+ assignment-id:
+ name: assignment_id
+ description: The unique identifier of the classroom assignment.
+ in: path
+ required: true
+ schema:
+ type: integer
+ classroom-id:
+ name: classroom_id
+ description: The unique identifier of the classroom.
+ in: path
+ required: true
+ schema:
+ type: integer
enterprise:
name: enterprise
description: The slug version of the enterprise name. You can also substitute
diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts
index ae214cf8c..d62e10554 100644
--- a/packages/openapi-typescript/examples/github-api.ts
+++ b/packages/openapi-typescript/examples/github-api.ts
@@ -190,6 +190,48 @@ export interface paths {
*/
get: operations["apps/get-by-slug"];
};
+ "/assignments/{assignment_id}": {
+ /**
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/get-an-assignment"];
+ };
+ "/assignments/{assignment_id}/accepted_assignments": {
+ /**
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/list-accepted-assigments-for-an-assignment"];
+ };
+ "/assignments/{assignment_id}/grades": {
+ /**
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ get: operations["classroom/get-assignment-grades"];
+ };
+ "/classrooms": {
+ /**
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ */
+ get: operations["classroom/list-classrooms"];
+ };
+ "/classrooms/{classroom_id}": {
+ /**
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ get: operations["classroom/get-a-classroom"];
+ };
+ "/classrooms/{classroom_id}/assignments": {
+ /**
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ get: operations["classroom/list-assignments-for-a-classroom"];
+ };
"/codes_of_conduct": {
/**
* Get all codes of conduct
@@ -291,6 +333,7 @@ export interface paths {
/**
* Update a gist
* @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * At least one of `description` or `files` is required.
*/
patch: operations["gists/update"];
};
@@ -5996,9 +6039,10 @@ export interface paths {
"/repos/{owner}/{repo}/rules/branches/{branch}": {
/**
* Get rules for a branch
- * @description Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- * branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- * are configured.
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
*/
get: operations["repos/get-branch-rules"];
};
@@ -8265,6 +8309,7 @@ export interface components {
/** @description The name of the CWE. */
name: string;
}[] | null;
+ /** @description The users who contributed to the advisory. */
credits: (readonly {
user: components["schemas"]["simple-user"];
type: components["schemas"]["security-advisory-credit-types"];
@@ -8909,7 +8954,7 @@ export interface components {
repository_selection: "all" | "selected";
/**
* Format: uri
- * @example https://api.github.com/installations/1/access_tokens
+ * @example https://api.github.com/app/installations/1/access_tokens
*/
access_tokens_url: string;
/**
@@ -9200,6 +9245,7 @@ export interface components {
has_wiki: boolean;
has_pages: boolean;
/**
+ * @deprecated
* @description Whether downloads are enabled.
* @default true
* @example true
@@ -9557,6 +9603,385 @@ export interface components {
/** Format: date-time */
expires_at: string | null;
};
+ /**
+ * Simple Classroom Repository
+ * @description A GitHub repository view for Classroom
+ */
+ "simple-classroom-repository": {
+ /**
+ * @description A unique identifier of the repository.
+ * @example 1296269
+ */
+ id: number;
+ /**
+ * @description The full, globally unique name of the repository.
+ * @example octocat/Hello-World
+ */
+ full_name: string;
+ /**
+ * Format: uri
+ * @description The URL to view the repository on GitHub.com.
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /**
+ * @description The GraphQL identifier of the repository.
+ * @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ */
+ node_id: string;
+ /** @description Whether the repository is private. */
+ private: boolean;
+ /**
+ * @description The default branch for the repository.
+ * @example main
+ */
+ default_branch: string;
+ };
+ /**
+ * Organization Simple for Classroom
+ * @description A GitHub organization.
+ */
+ "simple-classroom-organization": {
+ /** @example 1 */
+ id: number;
+ /** @example github */
+ login: string;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/github
+ */
+ html_url: string;
+ /** @example Github - Code thigns happen here */
+ name: string | null;
+ /** @example https://github.com/images/error/octocat_happy.gif */
+ avatar_url: string;
+ };
+ /**
+ * Classroom
+ * @description A GitHub Classroom classroom
+ */
+ classroom: {
+ /**
+ * @description Unique identifier of the classroom.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description The name of the classroom.
+ * @example Programming Elixir
+ */
+ name: string;
+ /**
+ * @description Whether classroom is archived.
+ * @example false
+ */
+ archived: boolean;
+ organization: components["schemas"]["simple-classroom-organization"];
+ /**
+ * @description The URL of the classroom on GitHub Classroom.
+ * @example https://classroom.github.com/classrooms/1-programming-elixir
+ */
+ url: string;
+ };
+ /**
+ * Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "classroom-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment creates a public repository.
+ * @example true
+ */
+ public_repo: boolean;
+ /**
+ * @description Assignment title.
+ * @example Intro to Binaries
+ */
+ title: string;
+ /**
+ * @description Whether it's a group assignment or individual assignment.
+ * @example individual
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /**
+ * @description The link that a student can use to accept the assignment.
+ * @example https://classroom.github.com/a/Lx7jiUgx
+ */
+ invite_link: string;
+ /**
+ * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
+ * @example true
+ */
+ invitations_enabled: boolean;
+ /**
+ * @description Sluggified name of the assignment.
+ * @example intro-to-binaries
+ */
+ slug: string;
+ /**
+ * @description Whether students are admins on created repository when a student accepts the assignment.
+ * @example true
+ */
+ students_are_repo_admins: boolean;
+ /**
+ * @description Whether feedback pull request will be created when a student accepts the assignment.
+ * @example true
+ */
+ feedback_pull_requests_enabled: boolean;
+ /**
+ * @description The maximum allowable teams for the assignment.
+ * @example 0
+ */
+ max_teams: number | null;
+ /**
+ * @description The maximum allowable members per team.
+ * @example 0
+ */
+ max_members: number | null;
+ /**
+ * @description The selected editor for the assignment.
+ * @example codespaces
+ */
+ editor: string;
+ /**
+ * @description The number of students that have accepted the assignment.
+ * @example 25
+ */
+ accepted: number;
+ /**
+ * @description The number of students that have submitted the assignment.
+ * @example 10
+ */
+ submitted: number;
+ /**
+ * @description The number of students that have passed the assignment.
+ * @example 10
+ */
+ passing: number;
+ /**
+ * @description The programming language used in the assignment.
+ * @example elixir
+ */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ * @example 2011-01-26T19:06:43Z
+ */
+ deadline: string | null;
+ starter_code_repository: components["schemas"]["simple-classroom-repository"];
+ classroom: components["schemas"]["classroom"];
+ };
+ /**
+ * Simple Classroom User
+ * @description A GitHub user simplified for Classroom.
+ */
+ "simple-classroom-user": {
+ /** @example 1 */
+ id: number;
+ /** @example octocat */
+ login: string;
+ /**
+ * Format: uri
+ * @example https://github.com/images/error/octocat_happy.gif
+ */
+ avatar_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ html_url: string;
+ };
+ /**
+ * Simple Classroom
+ * @description A GitHub Classroom classroom
+ */
+ "simple-classroom": {
+ /**
+ * @description Unique identifier of the classroom.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description The name of the classroom.
+ * @example Programming Elixir
+ */
+ name: string;
+ /**
+ * @description Returns whether classroom is archived or not.
+ * @example false
+ */
+ archived: boolean;
+ /**
+ * @description The url of the classroom on GitHub Classroom.
+ * @example https://classroom.github.com/classrooms/1-programming-elixir
+ */
+ url: string;
+ };
+ /**
+ * Simple Classroom Assignment
+ * @description A GitHub Classroom assignment
+ */
+ "simple-classroom-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment creates a public repository.
+ * @example true
+ */
+ public_repo: boolean;
+ /**
+ * @description Assignment title.
+ * @example Intro to Binaries
+ */
+ title: string;
+ /**
+ * @description Whether it's a Group Assignment or Individual Assignment.
+ * @example individual
+ * @enum {string}
+ */
+ type: "individual" | "group";
+ /**
+ * @description The link that a student can use to accept the assignment.
+ * @example https://classroom.github.com/a/Lx7jiUgx
+ */
+ invite_link: string;
+ /**
+ * @description Whether the invitation link is enabled. Visiting an enabled invitation link will accept the assignment.
+ * @example true
+ */
+ invitations_enabled: boolean;
+ /**
+ * @description Sluggified name of the assignment.
+ * @example intro-to-binaries
+ */
+ slug: string;
+ /**
+ * @description Whether students are admins on created repository on accepted assignment.
+ * @example true
+ */
+ students_are_repo_admins: boolean;
+ /**
+ * @description Whether feedback pull request will be created on assignment acceptance.
+ * @example true
+ */
+ feedback_pull_requests_enabled: boolean;
+ /**
+ * @description The maximum allowable teams for the assignment.
+ * @example 0
+ */
+ max_teams?: number | null;
+ /**
+ * @description The maximum allowable members per team.
+ * @example 0
+ */
+ max_members?: number | null;
+ /**
+ * @description The selected editor for the assignment.
+ * @example codespaces
+ */
+ editor: string;
+ /**
+ * @description The number of students that have accepted the assignment.
+ * @example 25
+ */
+ accepted: number;
+ /**
+ * @description The number of students that have submitted the assignment.
+ * @example 10
+ */
+ submitted: number;
+ /**
+ * @description The number of students that have passed the assignment.
+ * @example 10
+ */
+ passing: number;
+ /**
+ * @description The programming language used in the assignment.
+ * @example elixir
+ */
+ language: string;
+ /**
+ * Format: date-time
+ * @description The time at which the assignment is due.
+ * @example 2011-01-26T19:06:43Z
+ */
+ deadline: string | null;
+ classroom: components["schemas"]["simple-classroom"];
+ };
+ /**
+ * Classroom Accepted Assignment
+ * @description A GitHub Classroom accepted assignment
+ */
+ "classroom-accepted-assignment": {
+ /**
+ * @description Unique identifier of the repository.
+ * @example 42
+ */
+ id: number;
+ /**
+ * @description Whether an accepted assignment has been submitted.
+ * @example true
+ */
+ submitted: boolean;
+ /**
+ * @description Whether a submission passed.
+ * @example true
+ */
+ passing: boolean;
+ /**
+ * @description Count of student commits.
+ * @example 5
+ */
+ commit_count: number;
+ /**
+ * @description Most recent grade.
+ * @example 10/10
+ */
+ grade: string;
+ students: components["schemas"]["simple-classroom-user"][];
+ repository: components["schemas"]["simple-classroom-repository"];
+ assignment: components["schemas"]["simple-classroom-assignment"];
+ };
+ /**
+ * Classroom Assignment Grade
+ * @description Grade for a student or groups GitHub Classroom assignment
+ */
+ "classroom-assignment-grade": {
+ /** @description Name of the assignment */
+ assignment_name: string;
+ /** @description URL of the assignment */
+ assignment_url: string;
+ /** @description URL of the starter code for the assignment */
+ starter_code_url: string;
+ /** @description GitHub username of the student */
+ github_username: string;
+ /** @description Roster identifier of the student */
+ roster_identifier: string;
+ /** @description Name of the student's assignment repository */
+ student_repository_name: string;
+ /** @description URL of the student's assignment repository */
+ student_repository_url: string;
+ /** @description Timestamp of the student's assignment submission */
+ submission_timestamp: string;
+ /** @description Number of points awarded to the student */
+ points_awarded: number;
+ /** @description Number of points available for the assignment */
+ points_available: number;
+ /** @description If a group assignment, name of the group the student is in */
+ group_name?: string;
+ };
/**
* Code Of Conduct
* @description Code Of Conduct
@@ -14348,6 +14773,7 @@ export interface components {
has_wiki: boolean;
has_pages: boolean;
/**
+ * @deprecated
* @description Whether downloads are enabled.
* @default true
* @example true
@@ -22526,7 +22952,9 @@ export interface components {
};
/**
* Simple Installation
- * @description The GitHub App installation. This property is included when the event is configured for and sent to a GitHub App.
+ * @description The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
+ * for and sent to a GitHub App. For more information,
+ * see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)."
*/
"simple-installation": {
/**
@@ -22540,265 +22968,1380 @@ export interface components {
*/
node_id: string;
};
- /** @description A suite of checks performed on the code of a given code change */
- "simple-check-suite": {
- /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
- after?: string | null;
- app?: components["schemas"]["integration"];
- /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
- before?: string | null;
+ /**
+ * Organization Simple
+ * @description A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
+ * organization, or when the event occurs from activity in a repository owned by an organization.
+ */
+ "organization-simple-webhooks": {
+ /** @example github */
+ login: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDEyOk9yZ2FuaXphdGlvbjE= */
+ node_id: string;
/**
- * @example neutral
- * @enum {string|null}
+ * Format: uri
+ * @example https://api.github.com/orgs/github
*/
- conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null;
- /** Format: date-time */
- created_at?: string;
- /** @example master */
- head_branch?: string | null;
+ url: string;
/**
- * @description The SHA of the head commit that is being checked.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ * Format: uri
+ * @example https://api.github.com/orgs/github/repos
*/
- head_sha?: string;
- /** @example 5 */
- id?: number;
- /** @example MDEwOkNoZWNrU3VpdGU1 */
- node_id?: string;
- pull_requests?: components["schemas"]["pull-request-minimal"][];
- repository?: components["schemas"]["minimal-repository"];
+ repos_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/orgs/github/events
+ */
+ events_url: string;
+ /** @example https://api.github.com/orgs/github/hooks */
+ hooks_url: string;
+ /** @example https://api.github.com/orgs/github/issues */
+ issues_url: string;
+ /** @example https://api.github.com/orgs/github/members{/member} */
+ members_url: string;
+ /** @example https://api.github.com/orgs/github/public_members{/member} */
+ public_members_url: string;
+ /** @example https://github.com/images/error/octocat_happy.gif */
+ avatar_url: string;
+ /** @example A great organization */
+ description: string | null;
+ };
+ /**
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
+ */
+ "repository-webhooks": {
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ organization?: components["schemas"]["nullable-simple-user"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
+ /**
+ * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ default_branch: string;
+ /** @example 0 */
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_rebase_merge?: boolean;
+ template_repository?: ({
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
+ };
+ private?: boolean;
+ html_url?: string;
+ description?: string;
+ fork?: boolean;
+ url?: string;
+ archive_url?: string;
+ assignees_url?: string;
+ blobs_url?: string;
+ branches_url?: string;
+ collaborators_url?: string;
+ comments_url?: string;
+ commits_url?: string;
+ compare_url?: string;
+ contents_url?: string;
+ contributors_url?: string;
+ deployments_url?: string;
+ downloads_url?: string;
+ events_url?: string;
+ forks_url?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ pulls_url?: string;
+ releases_url?: string;
+ ssh_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ clone_url?: string;
+ mirror_url?: string;
+ hooks_url?: string;
+ svn_url?: string;
+ homepage?: string;
+ language?: string;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
+ is_template?: boolean;
+ topics?: string[];
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
+ visibility?: string;
+ pushed_at?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
+ allow_squash_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_update_branch?: boolean;
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ }) | null;
+ temp_clone_token?: string;
+ /**
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_squash_merge?: boolean;
+ /**
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
+ */
+ allow_auto_merge?: boolean;
+ /**
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
+ */
+ delete_branch_on_merge?: boolean;
+ /**
+ * @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
+ * @example false
+ */
+ allow_update_branch?: boolean;
+ /**
+ * @deprecated
+ * @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
+ */
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ /**
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
+ /**
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
+ */
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ anonymous_access_enabled?: boolean;
+ };
+ /**
+ * Simple User
+ * @description The GitHub user that triggered the event. This property is included in every webhook payload.
+ */
+ "simple-user-webhooks": {
+ name?: string | null;
+ email?: string | null;
+ /** @example octocat */
+ login: string;
+ /** @example 1 */
+ id: number;
+ /** @example MDQ6VXNlcjE= */
+ node_id: string;
+ /**
+ * Format: uri
+ * @example https://github.com/images/error/octocat_happy.gif
+ */
+ avatar_url: string;
+ /** @example 41d064eb2195891e12d0413f63227ea7 */
+ gravatar_id: string | null;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat
+ */
+ url: string;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat
+ */
+ html_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/followers
+ */
+ followers_url: string;
+ /** @example https://api.github.com/users/octocat/following{/other_user} */
+ following_url: string;
+ /** @example https://api.github.com/users/octocat/gists{/gist_id} */
+ gists_url: string;
+ /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
+ starred_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/subscriptions
+ */
+ subscriptions_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/orgs
+ */
+ organizations_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/repos
+ */
+ repos_url: string;
+ /** @example https://api.github.com/users/octocat/events{/privacy} */
+ events_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/users/octocat/received_events
+ */
+ received_events_url: string;
+ /** @example User */
+ type: string;
+ site_admin: boolean;
+ /** @example "2020-07-09T00:17:55Z" */
+ starred_at?: string;
+ };
+ /** @description A suite of checks performed on the code of a given code change */
+ "simple-check-suite": {
+ /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
+ after?: string | null;
+ app?: components["schemas"]["integration"];
+ /** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
+ before?: string | null;
+ /**
+ * @example neutral
+ * @enum {string|null}
+ */
+ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null;
+ /** Format: date-time */
+ created_at?: string;
+ /** @example master */
+ head_branch?: string | null;
+ /**
+ * @description The SHA of the head commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ */
+ head_sha?: string;
+ /** @example 5 */
+ id?: number;
+ /** @example MDEwOkNoZWNrU3VpdGU1 */
+ node_id?: string;
+ pull_requests?: components["schemas"]["pull-request-minimal"][];
+ repository?: components["schemas"]["minimal-repository"];
+ /**
+ * @example completed
+ * @enum {string}
+ */
+ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting";
+ /** Format: date-time */
+ updated_at?: string;
+ /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
+ url?: string;
+ };
+ /**
+ * CheckRun
+ * @description A check performed on the code of a given code change
+ */
+ "check-run-with-simple-check-suite": {
+ app: components["schemas"]["nullable-integration"];
+ check_suite: components["schemas"]["simple-check-suite"];
+ /**
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
+ */
+ completed_at: string | null;
+ /**
+ * @example neutral
+ * @enum {string|null}
+ */
+ conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
+ deployment?: components["schemas"]["deployment-simple"];
+ /** @example https://example.com */
+ details_url: string;
+ /** @example 42 */
+ external_id: string;
+ /**
+ * @description The SHA of the commit that is being checked.
+ * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ */
+ head_sha: string;
+ /** @example https://github.com/github/hello-world/runs/4 */
+ html_url: string;
+ /**
+ * @description The id of the check.
+ * @example 21
+ */
+ id: number;
+ /**
+ * @description The name of the check.
+ * @example test-coverage
+ */
+ name: string;
+ /** @example MDg6Q2hlY2tSdW40 */
+ node_id: string;
+ output: {
+ annotations_count: number;
+ /** Format: uri */
+ annotations_url: string;
+ summary: string | null;
+ text: string | null;
+ title: string | null;
+ };
+ pull_requests: components["schemas"]["pull-request-minimal"][];
+ /**
+ * Format: date-time
+ * @example 2018-05-04T01:14:52Z
+ */
+ started_at: string;
+ /**
+ * @description The phase of the lifecycle that the check is currently in.
+ * @example queued
+ * @enum {string}
+ */
+ status: "queued" | "in_progress" | "completed" | "pending";
+ /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
+ url: string;
+ };
+ /**
+ * Discussion
+ * @description A Discussion in a repository.
+ */
+ discussion: {
+ active_lock_reason: string | null;
+ answer_chosen_at: string | null;
+ /** User */
+ answer_chosen_by: ({
+ /** Format: uri */
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
+ /** Format: uri-template */
+ events_url?: string;
+ /** Format: uri */
+ followers_url?: string;
+ /** Format: uri-template */
+ following_url?: string;
+ /** Format: uri-template */
+ gists_url?: string;
+ gravatar_id?: string;
+ /** Format: uri */
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
+ /** Format: uri */
+ organizations_url?: string;
+ /** Format: uri */
+ received_events_url?: string;
+ /** Format: uri */
+ repos_url?: string;
+ site_admin?: boolean;
+ /** Format: uri-template */
+ starred_url?: string;
+ /** Format: uri */
+ subscriptions_url?: string;
+ /** @enum {string} */
+ type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ url?: string;
+ }) | null;
+ answer_html_url: string | null;
+ /**
+ * AuthorAssociation
+ * @description How the author is associated with the repository.
+ * @enum {string}
+ */
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ body: string;
+ category: {
+ /** Format: date-time */
+ created_at: string;
+ description: string;
+ emoji: string;
+ id: number;
+ is_answerable: boolean;
+ name: string;
+ node_id?: string;
+ repository_id: number;
+ slug: string;
+ updated_at: string;
+ };
+ comments: number;
+ /** Format: date-time */
+ created_at: string;
+ html_url: string;
+ id: number;
+ locked: boolean;
+ node_id: string;
+ number: number;
+ /** Reactions */
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ repository_url: string;
+ /**
+ * @description The current state of the discussion.
+ * `converting` means that the discussion is being converted from an issue.
+ * `transferring` means that the discussion is being transferred from another repository.
+ * @enum {string}
+ */
+ state: "open" | "closed" | "locked" | "converting" | "transferring";
+ /**
+ * @description The reason for the current state
+ * @example resolved
+ * @enum {string|null}
+ */
+ state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null;
+ timeline_url?: string;
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** User */
+ user: ({
+ /** Format: uri */
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
+ /** Format: uri-template */
+ events_url?: string;
+ /** Format: uri */
+ followers_url?: string;
+ /** Format: uri-template */
+ following_url?: string;
+ /** Format: uri-template */
+ gists_url?: string;
+ gravatar_id?: string;
+ /** Format: uri */
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
+ /** Format: uri */
+ organizations_url?: string;
+ /** Format: uri */
+ received_events_url?: string;
+ /** Format: uri */
+ repos_url?: string;
+ site_admin?: boolean;
+ /** Format: uri-template */
+ starred_url?: string;
+ /** Format: uri */
+ subscriptions_url?: string;
+ /** @enum {string} */
+ type?: "Bot" | "User" | "Organization";
+ /** Format: uri */
+ url?: string;
+ }) | null;
+ };
+ /**
+ * Merge Group
+ * @description A group of pull requests that the merge queue has grouped together to be merged.
+ */
+ "merge-group": {
+ /** @description The SHA of the merge group. */
+ head_sha: string;
+ /** @description The full ref of the merge group. */
+ head_ref: string;
+ /** @description The SHA of the merge group's parent commit. */
+ base_sha: string;
+ /** @description The full ref of the branch the merge group will be merged into. */
+ base_ref: string;
+ head_commit: components["schemas"]["simple-commit"];
+ };
+ /**
+ * Repository
+ * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ * when the event occurs from activity in a repository.
+ */
+ "nullable-repository-webhooks": ({
+ /**
+ * @description Unique identifier of the repository
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
+ node_id: string;
+ /**
+ * @description The name of the repository.
+ * @example Team Environment
+ */
+ name: string;
+ /** @example octocat/Hello-World */
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ organization?: components["schemas"]["nullable-simple-user"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ };
+ owner: components["schemas"]["simple-user"];
+ /**
+ * @description Whether the repository is private or public.
+ * @default false
+ */
+ private: boolean;
+ /**
+ * Format: uri
+ * @example https://github.com/octocat/Hello-World
+ */
+ html_url: string;
+ /** @example This your first repo! */
+ description: string | null;
+ fork: boolean;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/Hello-World
+ */
+ url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
+ archive_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
+ assignees_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
+ blobs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
+ branches_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
+ collaborators_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
+ comments_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
+ commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
+ compare_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
+ contents_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/contributors
+ */
+ contributors_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/deployments
+ */
+ deployments_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/downloads
+ */
+ downloads_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/events
+ */
+ events_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/forks
+ */
+ forks_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
+ git_commits_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
+ git_refs_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
+ git_tags_url: string;
+ /** @example git:github.com/octocat/Hello-World.git */
+ git_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
+ issue_comment_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
+ issue_events_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
+ issues_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
+ keys_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
+ labels_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/languages
+ */
+ languages_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/merges
+ */
+ merges_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
+ milestones_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
+ notifications_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
+ pulls_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
+ releases_url: string;
+ /** @example git@github.com:octocat/Hello-World.git */
+ ssh_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/stargazers
+ */
+ stargazers_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscribers
+ */
+ subscribers_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/subscription
+ */
+ subscription_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/tags
+ */
+ tags_url: string;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/teams
+ */
+ teams_url: string;
+ /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
+ trees_url: string;
+ /** @example https://github.com/octocat/Hello-World.git */
+ clone_url: string;
+ /**
+ * Format: uri
+ * @example git:git.example.com/octocat/Hello-World
+ */
+ mirror_url: string | null;
+ /**
+ * Format: uri
+ * @example http://api.github.com/repos/octocat/Hello-World/hooks
+ */
+ hooks_url: string;
+ /**
+ * Format: uri
+ * @example https://svn.github.com/octocat/Hello-World
+ */
+ svn_url: string;
+ /**
+ * Format: uri
+ * @example https://github.com
+ */
+ homepage: string | null;
+ language: string | null;
+ /** @example 9 */
+ forks_count: number;
+ /** @example 80 */
+ stargazers_count: number;
+ /** @example 80 */
+ watchers_count: number;
+ /**
+ * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0.
+ * @example 108
+ */
+ size: number;
+ /**
+ * @description The default branch of the repository.
+ * @example master
+ */
+ default_branch: string;
+ /** @example 0 */
+ open_issues_count: number;
+ /**
+ * @description Whether this repository acts as a template that can be used to generate new repositories.
+ * @default false
+ * @example true
+ */
+ is_template?: boolean;
+ topics?: string[];
+ /**
+ * @description Whether issues are enabled.
+ * @default true
+ * @example true
+ */
+ has_issues: boolean;
+ /**
+ * @description Whether projects are enabled.
+ * @default true
+ * @example true
+ */
+ has_projects: boolean;
+ /**
+ * @description Whether the wiki is enabled.
+ * @default true
+ * @example true
+ */
+ has_wiki: boolean;
+ has_pages: boolean;
+ /**
+ * @description Whether downloads are enabled.
+ * @default true
+ * @example true
+ */
+ has_downloads: boolean;
+ /**
+ * @description Whether discussions are enabled.
+ * @default false
+ * @example true
+ */
+ has_discussions?: boolean;
+ /**
+ * @description Whether the repository is archived.
+ * @default false
+ */
+ archived: boolean;
+ /** @description Returns whether or not this repository disabled. */
+ disabled: boolean;
+ /**
+ * @description The repository visibility: public, private, or internal.
+ * @default public
+ */
+ visibility?: string;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:06:43Z
+ */
+ pushed_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:01:12Z
+ */
+ created_at: string | null;
+ /**
+ * Format: date-time
+ * @example 2011-01-26T19:14:43Z
+ */
+ updated_at: string | null;
+ /**
+ * @description Whether to allow rebase merges for pull requests.
+ * @default true
+ * @example true
+ */
+ allow_rebase_merge?: boolean;
+ template_repository?: ({
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ avatar_url?: string;
+ gravatar_id?: string;
+ url?: string;
+ html_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ organizations_url?: string;
+ repos_url?: string;
+ events_url?: string;
+ received_events_url?: string;
+ type?: string;
+ site_admin?: boolean;
+ };
+ private?: boolean;
+ html_url?: string;
+ description?: string;
+ fork?: boolean;
+ url?: string;
+ archive_url?: string;
+ assignees_url?: string;
+ blobs_url?: string;
+ branches_url?: string;
+ collaborators_url?: string;
+ comments_url?: string;
+ commits_url?: string;
+ compare_url?: string;
+ contents_url?: string;
+ contributors_url?: string;
+ deployments_url?: string;
+ downloads_url?: string;
+ events_url?: string;
+ forks_url?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ languages_url?: string;
+ merges_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ pulls_url?: string;
+ releases_url?: string;
+ ssh_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ clone_url?: string;
+ mirror_url?: string;
+ hooks_url?: string;
+ svn_url?: string;
+ homepage?: string;
+ language?: string;
+ forks_count?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ size?: number;
+ default_branch?: string;
+ open_issues_count?: number;
+ is_template?: boolean;
+ topics?: string[];
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_downloads?: boolean;
+ archived?: boolean;
+ disabled?: boolean;
+ visibility?: string;
+ pushed_at?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ admin?: boolean;
+ maintain?: boolean;
+ push?: boolean;
+ triage?: boolean;
+ pull?: boolean;
+ };
+ allow_rebase_merge?: boolean;
+ temp_clone_token?: string;
+ allow_squash_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_update_branch?: boolean;
+ use_squash_pr_title_as_default?: boolean;
+ /**
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
+ */
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ /**
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ /**
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ * @enum {string}
+ */
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ /**
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
+ */
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ }) | null;
+ temp_clone_token?: string;
/**
- * @example completed
- * @enum {string}
+ * @description Whether to allow squash merges for pull requests.
+ * @default true
+ * @example true
*/
- status?: "queued" | "in_progress" | "completed" | "pending" | "waiting";
- /** Format: date-time */
- updated_at?: string;
- /** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
- url?: string;
- };
- /**
- * CheckRun
- * @description A check performed on the code of a given code change
- */
- "check-run-with-simple-check-suite": {
- app: components["schemas"]["nullable-integration"];
- check_suite: components["schemas"]["simple-check-suite"];
+ allow_squash_merge?: boolean;
/**
- * Format: date-time
- * @example 2018-05-04T01:14:52Z
+ * @description Whether to allow Auto-merge to be used on pull requests.
+ * @default false
+ * @example false
*/
- completed_at: string | null;
+ allow_auto_merge?: boolean;
/**
- * @example neutral
- * @enum {string|null}
+ * @description Whether to delete head branches when pull requests are merged
+ * @default false
+ * @example false
*/
- conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
- deployment?: components["schemas"]["deployment-simple"];
- /** @example https://example.com */
- details_url: string;
- /** @example 42 */
- external_id: string;
+ delete_branch_on_merge?: boolean;
/**
- * @description The SHA of the commit that is being checked.
- * @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
+ * @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
+ * @example false
*/
- head_sha: string;
- /** @example https://github.com/github/hello-world/runs/4 */
- html_url: string;
+ allow_update_branch?: boolean;
/**
- * @description The id of the check.
- * @example 21
+ * @deprecated
+ * @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
*/
- id: number;
+ use_squash_pr_title_as_default?: boolean;
/**
- * @description The name of the check.
- * @example test-coverage
+ * @description The default value for a squash merge commit title:
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `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 {string}
*/
- name: string;
- /** @example MDg6Q2hlY2tSdW40 */
- node_id: string;
- output: {
- annotations_count: number;
- /** Format: uri */
- annotations_url: string;
- summary: string | null;
- text: string | null;
- title: string | null;
- };
- pull_requests: components["schemas"]["pull-request-minimal"][];
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
- * Format: date-time
- * @example 2018-05-04T01:14:52Z
+ * @description The default value for a squash merge commit message:
+ *
+ * - `PR_BODY` - default to the pull request's body.
+ * - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ * - `BLANK` - default to a blank commit message.
+ * @enum {string}
*/
- started_at: string;
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
- * @description The phase of the lifecycle that the check is currently in.
- * @example queued
+ * @description The default value for a merge commit title.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- status: "queued" | "in_progress" | "completed" | "pending";
- /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- url: string;
- };
- /**
- * Discussion
- * @description A Discussion in a repository.
- */
- discussion: {
- active_lock_reason: string | null;
- answer_chosen_at: string | null;
- /** User */
- answer_chosen_by: ({
- /** Format: uri */
- avatar_url?: string;
- deleted?: boolean;
- email?: string | null;
- /** Format: uri-template */
- events_url?: string;
- /** Format: uri */
- followers_url?: string;
- /** Format: uri-template */
- following_url?: string;
- /** Format: uri-template */
- gists_url?: string;
- gravatar_id?: string;
- /** Format: uri */
- html_url?: string;
- id: number;
- login: string;
- name?: string;
- node_id?: string;
- /** Format: uri */
- organizations_url?: string;
- /** Format: uri */
- received_events_url?: string;
- /** Format: uri */
- repos_url?: string;
- site_admin?: boolean;
- /** Format: uri-template */
- starred_url?: string;
- /** Format: uri */
- subscriptions_url?: string;
- /** @enum {string} */
- type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- url?: string;
- }) | null;
- answer_html_url: string | null;
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
- * AuthorAssociation
- * @description How the author is associated with the repository.
+ * @description The default value for a merge commit message.
+ *
+ * - `PR_TITLE` - default to the pull request's title.
+ * - `PR_BODY` - default to the pull request's body.
+ * - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- body: string;
- category: {
- /** Format: date-time */
- created_at: string;
- description: string;
- emoji: string;
- id: number;
- is_answerable: boolean;
- name: string;
- node_id?: string;
- repository_id: number;
- slug: string;
- updated_at: string;
- };
- comments: number;
- /** Format: date-time */
- created_at: string;
- html_url: string;
- id: number;
- locked: boolean;
- node_id: string;
- number: number;
- /** Reactions */
- reactions?: {
- "+1": number;
- "-1": number;
- confused: number;
- eyes: number;
- heart: number;
- hooray: number;
- laugh: number;
- rocket: number;
- total_count: number;
- /** Format: uri */
- url: string;
- };
- repository_url: string;
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
- * @description The current state of the discussion.
- * `converting` means that the discussion is being converted from an issue.
- * `transferring` means that the discussion is being transferred from another repository.
- * @enum {string}
+ * @description Whether to allow merge commits for pull requests.
+ * @default true
+ * @example true
*/
- state: "open" | "closed" | "locked" | "converting" | "transferring";
+ allow_merge_commit?: boolean;
+ /** @description Whether to allow forking this repo */
+ allow_forking?: boolean;
/**
- * @description The reason for the current state
- * @example resolved
- * @enum {string|null}
+ * @description Whether to require contributors to sign off on web-based commits
+ * @default false
*/
- state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null;
- timeline_url?: string;
- title: string;
- /** Format: date-time */
- updated_at: string;
- /** User */
- user: ({
- /** Format: uri */
- avatar_url?: string;
- deleted?: boolean;
- email?: string | null;
- /** Format: uri-template */
- events_url?: string;
- /** Format: uri */
- followers_url?: string;
- /** Format: uri-template */
- following_url?: string;
- /** Format: uri-template */
- gists_url?: string;
- gravatar_id?: string;
- /** Format: uri */
- html_url?: string;
- id: number;
- login: string;
- name?: string;
- node_id?: string;
- /** Format: uri */
- organizations_url?: string;
- /** Format: uri */
- received_events_url?: string;
- /** Format: uri */
- repos_url?: string;
- site_admin?: boolean;
- /** Format: uri-template */
- starred_url?: string;
- /** Format: uri */
- subscriptions_url?: string;
- /** @enum {string} */
- type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- url?: string;
- }) | null;
- };
- /**
- * Merge Group
- * @description A group of pull requests that the merge queue has grouped together to be merged.
- */
- "merge-group": {
- /** @description The SHA of the merge group. */
- head_sha: string;
- /** @description The full ref of the merge group. */
- head_ref: string;
- /** @description The SHA of the merge group's parent commit. */
- base_sha: string;
- /** @description The full ref of the branch the merge group will be merged into. */
- base_ref: string;
- head_commit: components["schemas"]["simple-commit"];
- };
+ web_commit_signoff_required?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
+ /** @example "2020-07-09T00:17:42Z" */
+ starred_at?: string;
+ /** @description Whether anonymous git access is enabled for this repository */
+ anonymous_access_enabled?: boolean;
+ }) | null;
/**
* Personal Access Token Request
* @description Details of a Personal Access Token Request.
@@ -22981,9 +24524,9 @@ export interface components {
action: "disabled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection configuration enabled event */
"webhook-branch-protection-configuration-enabled": {
@@ -22991,9 +24534,9 @@ export interface components {
action: "enabled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule created event */
"webhook-branch-protection-rule-created": {
@@ -23001,8 +24544,8 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -23047,7 +24590,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule deleted event */
"webhook-branch-protection-rule-deleted": {
@@ -23055,8 +24598,8 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -23101,7 +24644,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** branch protection rule edited event */
"webhook-branch-protection-rule-edited": {
@@ -23135,8 +24678,8 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* branch protection rule
* @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.
@@ -23181,7 +24724,7 @@ export interface components {
/** Format: date-time */
updated_at: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Check Run Completed Event */
"webhook-check-run-completed": {
@@ -23189,9 +24732,9 @@ export interface components {
action?: "completed";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Completed Event
@@ -23207,9 +24750,9 @@ export interface components {
action?: "created";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Created Event
@@ -23225,14 +24768,14 @@ export interface components {
action: "requested_action";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The action requested by the user. */
requested_action?: {
/** @description The integrator reference of the action requested by the user. */
identifier?: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Requested Action Event
@@ -23248,9 +24791,9 @@ export interface components {
action?: "rerequested";
check_run: components["schemas"]["check-run-with-simple-check-suite"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* Check Run Re-Requested Event
@@ -23497,9 +25040,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** check_suite requested event */
"webhook-check-suite-requested": {
@@ -23738,9 +25281,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** check_suite rerequested event */
"webhook-check-suite-rerequested": {
@@ -23979,9 +25522,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert appeared_in_branch event */
"webhook-code-scanning-alert-appeared-in-branch": {
@@ -24105,11 +25648,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert closed_by_user event */
"webhook-code-scanning-alert-closed-by-user": {
@@ -24240,11 +25783,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert created event */
"webhook-code-scanning-alert-created": {
@@ -24337,11 +25880,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert fixed event */
"webhook-code-scanning-alert-fixed": {
@@ -24474,11 +26017,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert reopened event */
"webhook-code-scanning-alert-reopened": {
@@ -24567,11 +26110,11 @@ export interface components {
commit_oid: string | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string | null;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** code_scanning_alert reopened_by_user event */
"webhook-code-scanning-alert-reopened-by-user": {
@@ -24653,11 +26196,11 @@ export interface components {
commit_oid: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @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. */
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** commit_comment created event */
"webhook-commit-comment-created": {
@@ -24748,9 +26291,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** create event */
"webhook-create": {
@@ -24760,7 +26303,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The name of the repository's default branch (usually `main`). */
master_branch: string;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pusher type for the event. Can be either `user` or a deploy key. */
pusher_type: string;
/** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
@@ -24770,14 +26313,14 @@ export interface components {
* @enum {string}
*/
ref_type: "tag" | "branch";
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** delete event */
"webhook-delete": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pusher type for the event. Can be either `user` or a deploy key. */
pusher_type: string;
/** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
@@ -24787,8 +26330,8 @@ export interface components {
* @enum {string}
*/
ref_type: "tag" | "branch";
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert auto-dismissed event */
"webhook-dependabot-alert-auto-dismissed": {
@@ -24796,10 +26339,10 @@ export interface components {
action: "auto_dismissed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert auto-reopened event */
"webhook-dependabot-alert-auto-reopened": {
@@ -24807,10 +26350,10 @@ export interface components {
action: "auto_reopened";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert created event */
"webhook-dependabot-alert-created": {
@@ -24818,10 +26361,10 @@ export interface components {
action: "created";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert dismissed event */
"webhook-dependabot-alert-dismissed": {
@@ -24829,10 +26372,10 @@ export interface components {
action: "dismissed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert fixed event */
"webhook-dependabot-alert-fixed": {
@@ -24840,10 +26383,10 @@ export interface components {
action: "fixed";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert reintroduced event */
"webhook-dependabot-alert-reintroduced": {
@@ -24851,10 +26394,10 @@ export interface components {
action: "reintroduced";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Dependabot alert reopened event */
"webhook-dependabot-alert-reopened": {
@@ -24862,10 +26405,10 @@ export interface components {
action: "reopened";
alert: components["schemas"]["dependabot-alert"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
enterprise?: components["schemas"]["enterprise"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deploy_key created event */
"webhook-deploy-key-created": {
@@ -24886,9 +26429,9 @@ export interface components {
url: string;
verified: boolean;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deploy_key deleted event */
"webhook-deploy-key-deleted": {
@@ -24909,9 +26452,9 @@ export interface components {
url: string;
verified: boolean;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** deployment created event */
"webhook-deployment-created": {
@@ -25115,9 +26658,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -25432,10 +26975,10 @@ export interface components {
deployment_callback_url?: string;
deployment?: components["schemas"]["deployment"];
pull_requests?: components["schemas"]["pull-request"][];
- repository?: components["schemas"]["repository"];
- organization?: components["schemas"]["organization-simple"];
+ repository?: components["schemas"]["repository-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
installation?: components["schemas"]["simple-installation"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-deployment-review-approved": {
/** @enum {string} */
@@ -25463,8 +27006,8 @@ export interface components {
comment?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
reviewers?: ({
/** User */
reviewer?: ({
@@ -25506,7 +27049,7 @@ export interface components {
/** @enum {string} */
type?: "User";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run?: {
conclusion: Record | null;
@@ -25835,8 +27378,8 @@ export interface components {
comment?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
reviewers?: ({
/** User */
reviewer?: ({
@@ -25878,7 +27421,7 @@ export interface components {
/** @enum {string} */
type?: "User";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run?: {
conclusion: Record | null;
@@ -26187,8 +27730,8 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
environment: string;
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requestor: ({
/** Format: uri */
@@ -26267,7 +27810,7 @@ export interface components {
/** @enum {string} */
type?: "User" | "Team";
})[];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
since: string;
workflow_job_run: {
conclusion: Record | null;
@@ -26987,9 +28530,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow?: {
/** Format: uri */
@@ -27367,9 +28910,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion category changed event */
"webhook-discussion-category-changed": {
@@ -27395,9 +28938,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion closed event */
"webhook-discussion-closed": {
@@ -27406,9 +28949,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment created event */
"webhook-discussion-comment-created": {
@@ -27486,9 +29029,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment deleted event */
"webhook-discussion-comment-deleted": {
@@ -27566,9 +29109,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion_comment edited event */
"webhook-discussion-comment-edited": {
@@ -27651,9 +29194,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion created event */
"webhook-discussion-created": {
@@ -27854,9 +29397,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion deleted event */
"webhook-discussion-deleted": {
@@ -27865,9 +29408,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion edited event */
"webhook-discussion-edited": {
@@ -27884,9 +29427,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion labeled event */
"webhook-discussion-labeled": {
@@ -27911,9 +29454,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion locked event */
"webhook-discussion-locked": {
@@ -27922,9 +29465,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion pinned event */
"webhook-discussion-pinned": {
@@ -27933,9 +29476,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion reopened event */
"webhook-discussion-reopened": {
@@ -27944,9 +29487,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion transferred event */
"webhook-discussion-transferred": {
@@ -27954,14 +29497,14 @@ export interface components {
action: "transferred";
changes: {
new_discussion: components["schemas"]["discussion"];
- new_repository: components["schemas"]["repository"];
+ new_repository: components["schemas"]["repository-webhooks"];
};
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unanswered event */
"webhook-discussion-unanswered": {
@@ -28039,9 +29582,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** discussion unlabeled event */
"webhook-discussion-unlabeled": {
@@ -28066,9 +29609,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unlocked event */
"webhook-discussion-unlocked": {
@@ -28077,9 +29620,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** discussion unpinned event */
"webhook-discussion-unpinned": {
@@ -28088,9 +29631,9 @@ export interface components {
discussion: components["schemas"]["discussion"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/**
* fork event
@@ -28432,9 +29975,9 @@ export interface components {
watchers_count?: number;
});
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** github_app_authorization revoked event */
"webhook-github-app-authorization-revoked": {
@@ -28442,15 +29985,15 @@ export interface components {
action: "revoked";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** gollum event */
"webhook-gollum": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pages that were updated. */
pages: ({
/**
@@ -28471,8 +30014,8 @@ export interface components {
/** @description The current page title. */
title: string;
})[];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation created event */
"webhook-installation-created": {
@@ -28480,7 +30023,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -28492,7 +30035,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/** User */
requester?: ({
/** Format: uri */
@@ -28530,7 +30073,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation deleted event */
"webhook-installation-deleted": {
@@ -28538,7 +30081,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -28550,9 +30093,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: Record | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation new_permissions_accepted event */
"webhook-installation-new-permissions-accepted": {
@@ -28560,7 +30103,7 @@ export interface components {
action: "new_permissions_accepted";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -28572,9 +30115,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: Record | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation_repositories added event */
"webhook-installation-repositories-added": {
@@ -28582,7 +30125,7 @@ export interface components {
action: "added";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects, which were added to the installation. */
repositories_added: {
full_name: string;
@@ -28605,7 +30148,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private?: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description Describe whether all repositories have been selected or there's a selection involved
* @enum {string}
@@ -28648,7 +30191,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation_repositories removed event */
"webhook-installation-repositories-removed": {
@@ -28656,7 +30199,7 @@ export interface components {
action: "removed";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects, which were added to the installation. */
repositories_added: {
full_name: string;
@@ -28679,7 +30222,7 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description Describe whether all repositories have been selected or there's a selection involved
* @enum {string}
@@ -28722,7 +30265,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** installation suspend event */
"webhook-installation-suspend": {
@@ -28730,7 +30273,7 @@ export interface components {
action: "suspend";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -28742,9 +30285,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: Record | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
"webhook-installation-target-renamed": {
account: {
@@ -28797,9 +30340,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
target_type: string;
};
/** installation unsuspend event */
@@ -28808,7 +30351,7 @@ export interface components {
action: "unsuspend";
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description An array of repository objects that the installation can access. */
repositories?: {
full_name: string;
@@ -28820,9 +30363,9 @@ export interface components {
/** @description Whether the repository is private or public. */
private: boolean;
}[];
- repository?: components["schemas"]["repository"];
+ repository?: components["schemas"]["repository-webhooks"];
requester?: Record | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment created event */
"webhook-issue-comment-created": {
@@ -29434,9 +30977,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment deleted event */
"webhook-issue-comment-deleted": {
@@ -30048,9 +31591,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issue_comment edited event */
"webhook-issue-comment-edited": {
@@ -30669,9 +32212,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues assigned event */
"webhook-issues-assigned": {
@@ -31129,9 +32672,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues closed event */
"webhook-issues-closed": {
@@ -31608,9 +33151,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues deleted event */
"webhook-issues-deleted": {
@@ -32028,9 +33571,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues demilestoned event */
"webhook-issues-demilestoned": {
@@ -32643,9 +34186,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues edited event */
"webhook-issues-edited": {
@@ -33090,9 +34633,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues labeled event */
"webhook-issues-labeled": {
@@ -33526,9 +35069,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues locked event */
"webhook-issues-locked": {
@@ -34002,9 +35545,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues milestoned event */
"webhook-issues-milestoned": {
@@ -34617,9 +36160,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues opened event */
"webhook-issues-opened": {
@@ -35684,9 +37227,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues pinned event */
"webhook-issues-pinned": {
@@ -36104,9 +37647,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues reopened event */
"webhook-issues-reopened": {
@@ -36579,9 +38122,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues transferred event */
"webhook-issues-transferred": {
@@ -37653,9 +39196,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unassigned event */
"webhook-issues-unassigned": {
@@ -38113,9 +39656,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unlabeled event */
"webhook-issues-unlabeled": {
@@ -38549,9 +40092,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unlocked event */
"webhook-issues-unlocked": {
@@ -39024,9 +40567,9 @@ export interface components {
url?: string;
};
});
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** issues unpinned event */
"webhook-issues-unpinned": {
@@ -39444,9 +40987,9 @@ export interface components {
url?: string;
}) | null;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** label created event */
"webhook-label-created": {
@@ -39470,9 +41013,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** label deleted event */
"webhook-label-deleted": {
@@ -39496,9 +41039,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** label edited event */
"webhook-label-edited": {
@@ -39537,9 +41080,9 @@ export interface components {
*/
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase cancelled event */
"webhook-marketplace-purchase-cancelled": {
@@ -39599,7 +41142,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -39627,8 +41170,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase changed event */
"webhook-marketplace-purchase-changed": {
@@ -39688,7 +41231,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -39716,8 +41259,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase pending_change event */
"webhook-marketplace-purchase-pending-change": {
@@ -39777,7 +41320,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -39805,8 +41348,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase pending_change_cancelled event */
"webhook-marketplace-purchase-pending-change-cancelled": {
@@ -39843,7 +41386,7 @@ export interface components {
}) & {
next_billing_date: string;
};
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -39871,8 +41414,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** marketplace_purchase purchased event */
"webhook-marketplace-purchase-purchased": {
@@ -39932,7 +41475,7 @@ export interface components {
};
unit_count?: number;
});
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
previous_marketplace_purchase?: {
account: {
@@ -39960,8 +41503,8 @@ export interface components {
};
unit_count: number;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member added event */
"webhook-member-added": {
@@ -40012,9 +41555,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member edited event */
"webhook-member-edited": {
@@ -40070,9 +41613,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** member removed event */
"webhook-member-removed": {
@@ -40117,9 +41660,9 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** membership added event */
"webhook-membership-added": {
@@ -40164,8 +41707,8 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
@@ -40314,8 +41857,8 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
@@ -40426,9 +41969,9 @@ export interface components {
action: "checks_requested";
installation?: components["schemas"]["simple-installation"];
merge_group: components["schemas"]["merge-group"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-merge-group-destroyed": {
/** @enum {string} */
@@ -40440,9 +41983,9 @@ export interface components {
reason?: "merged" | "invalidated" | "dequeued";
installation?: components["schemas"]["simple-installation"];
merge_group: components["schemas"]["merge-group"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** meta deleted event */
"webhook-meta-deleted": {
@@ -40470,9 +42013,9 @@ export interface components {
/** @description The id of the modified webhook. */
hook_id: number;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["nullable-repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** milestone closed event */
"webhook-milestone-closed": {
@@ -40551,9 +42094,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone created event */
"webhook-milestone-created": {
@@ -40632,9 +42175,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone deleted event */
"webhook-milestone-deleted": {
@@ -40713,9 +42256,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone edited event */
"webhook-milestone-edited": {
@@ -40809,9 +42352,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** milestone opened event */
"webhook-milestone-opened": {
@@ -40890,9 +42433,9 @@ export interface components {
/** Format: uri */
url: string;
};
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** org_block blocked event */
"webhook-org-block-blocked": {
@@ -40937,9 +42480,9 @@ export interface components {
}) | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** org_block unblocked event */
"webhook-org-block-unblocked": {
@@ -40984,9 +42527,9 @@ export interface components {
}) | null;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization deleted event */
"webhook-organization-deleted": {
@@ -41043,9 +42586,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization member_added event */
"webhook-organization-member-added": {
@@ -41102,9 +42645,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization member_invited event */
"webhook-organization-member-invited": {
@@ -41166,9 +42709,9 @@ export interface components {
team_count: number;
invitation_source?: string;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** User */
user?: ({
/** Format: uri */
@@ -41262,9 +42805,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** organization renamed event */
"webhook-organization-renamed": {
@@ -41326,9 +42869,9 @@ export interface components {
url?: string;
}) | null;
};
- organization: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Ruby Gems metadata */
"webhook-rubygems-metadata": {
@@ -41355,7 +42898,7 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
package: {
created_at: string | null;
@@ -41603,8 +43146,8 @@ export interface components {
} | null;
updated_at: string | null;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** package updated event */
"webhook-package-updated": {
@@ -41612,7 +43155,7 @@ export interface components {
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
package: {
created_at: string;
@@ -41804,8 +43347,8 @@ export interface components {
} | null;
updated_at: string;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** page_build event */
"webhook-page-build": {
@@ -41862,17 +43405,17 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
id: number;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** personal_access_token_request approved event */
"webhook-personal-access-token-request-approved": {
/** @enum {string} */
action: "approved";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request cancelled event */
@@ -41880,8 +43423,8 @@ export interface components {
/** @enum {string} */
action: "cancelled";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request created event */
@@ -41889,8 +43432,8 @@ export interface components {
/** @enum {string} */
action: "created";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request denied event */
@@ -41898,8 +43441,8 @@ export interface components {
/** @enum {string} */
action: "denied";
personal_access_token_request: components["schemas"]["personal-access-token-request"];
- organization: components["schemas"]["organization-simple"];
- sender: components["schemas"]["simple-user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
installation: components["schemas"]["simple-installation"];
};
"webhook-ping": {
@@ -41944,9 +43487,9 @@ export interface components {
};
/** @description The ID of the webhook that triggered the ping. */
hook_id?: number;
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/** @description Random string of GitHub zen. */
zen?: string;
};
@@ -41966,7 +43509,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -42027,8 +43570,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card created event */
"webhook-project-card-created": {
@@ -42036,7 +43579,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -42097,8 +43640,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card deleted event */
"webhook-project-card-deleted": {
@@ -42106,7 +43649,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -42167,8 +43710,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["nullable-repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card edited event */
"webhook-project-card-edited": {
@@ -42181,7 +43724,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
project_card: {
after_id?: number | null;
@@ -42242,8 +43785,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_card moved event */
"webhook-project-card-moved": {
@@ -42256,7 +43799,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
project_card: ({
after_id?: number | null;
/** @description Whether or not the card is archived */
@@ -42348,8 +43891,8 @@ export interface components {
updated_at?: string;
url?: string;
});
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project closed event */
"webhook-project-closed": {
@@ -42357,7 +43900,7 @@ export interface components {
action: "closed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -42422,8 +43965,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project_column created event */
"webhook-project-column-created": {
@@ -42431,7 +43974,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -42451,8 +43994,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column deleted event */
"webhook-project-column-deleted": {
@@ -42460,7 +44003,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -42480,8 +44023,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["nullable-repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column edited event */
"webhook-project-column-edited": {
@@ -42494,7 +44037,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -42514,8 +44057,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project_column moved event */
"webhook-project-column-moved": {
@@ -42523,7 +44066,7 @@ export interface components {
action: "moved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Column */
project_column: {
after_id?: number | null;
@@ -42543,8 +44086,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project created event */
"webhook-project-created": {
@@ -42552,7 +44095,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -42617,8 +44160,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** project deleted event */
"webhook-project-deleted": {
@@ -42626,7 +44169,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -42691,8 +44234,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["nullable-repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project edited event */
"webhook-project-edited": {
@@ -42711,7 +44254,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -42776,8 +44319,8 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** project reopened event */
"webhook-project-reopened": {
@@ -42785,7 +44328,7 @@ export interface components {
action: "reopened";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project */
project: {
/** @description Body of the project */
@@ -42850,35 +44393,35 @@ export interface components {
/** Format: uri */
url: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Closed Event */
"webhook-projects-v2-project-closed": {
/** @enum {string} */
action: "closed";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** @description A project was created */
"webhook-projects-v2-project-created": {
/** @enum {string} */
action: "created";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Deleted Event */
"webhook-projects-v2-project-deleted": {
/** @enum {string} */
action: "deleted";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Edited Event */
"webhook-projects-v2-project-edited": {
@@ -42903,9 +44446,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Archived Event */
"webhook-projects-v2-item-archived": {
@@ -42920,9 +44463,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Converted Event */
"webhook-projects-v2-item-converted": {
@@ -42935,27 +44478,27 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Created Event */
"webhook-projects-v2-item-created": {
/** @enum {string} */
action: "created";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Deleted Event */
"webhook-projects-v2-item-deleted": {
/** @enum {string} */
action: "deleted";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Edited Event */
"webhook-projects-v2-item-edited": {
@@ -42973,9 +44516,9 @@ export interface components {
};
}]>;
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Reordered Event */
"webhook-projects-v2-item-reordered": {
@@ -42988,9 +44531,9 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Item Restored Event */
"webhook-projects-v2-item-restored": {
@@ -43005,26 +44548,26 @@ export interface components {
};
};
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2_item: components["schemas"]["projects-v2-item"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Projects v2 Project Reopened Event */
"webhook-projects-v2-project-reopened": {
/** @enum {string} */
action: "reopened";
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
projects_v2: components["schemas"]["projects-v2"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** public event */
"webhook-public": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request assigned event */
"webhook-pull-request-assigned": {
@@ -43071,7 +44614,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -44249,8 +45792,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request auto_merge_disabled event */
"webhook-pull-request-auto-merge-disabled": {
@@ -44259,7 +45802,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -45438,8 +46981,8 @@ export interface components {
}) | null;
};
reason: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request auto_merge_enabled event */
"webhook-pull-request-auto-merge-enabled": {
@@ -45448,7 +46991,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -46627,8 +48170,8 @@ export interface components {
}) | null;
};
reason?: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request closed event */
"webhook-pull-request-closed": {
@@ -46638,7 +48181,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -46688,8 +48231,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request converted_to_draft event */
"webhook-pull-request-converted-to-draft": {
@@ -46699,7 +48242,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -46749,8 +48292,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request demilestoned event */
"webhook-pull-request-demilestoned": {
@@ -46760,7 +48303,7 @@ export interface components {
milestone?: components["schemas"]["milestone"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -47938,8 +49481,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request dequeued event */
"webhook-pull-request-dequeued": {
@@ -47948,7 +49491,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -49127,8 +50670,8 @@ export interface components {
}) | null;
};
reason: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request edited event */
"webhook-pull-request-edited": {
@@ -49157,7 +50700,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -49207,8 +50750,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request enqueued event */
"webhook-pull-request-enqueued": {
@@ -49217,7 +50760,7 @@ export interface components {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -50395,8 +51938,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request labeled event */
"webhook-pull-request-labeled": {
@@ -50422,7 +51965,7 @@ export interface components {
};
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -51600,8 +53143,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request locked event */
"webhook-pull-request-locked": {
@@ -51611,7 +53154,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -52789,8 +54332,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request milestoned event */
"webhook-pull-request-milestoned": {
@@ -52800,7 +54343,7 @@ export interface components {
milestone?: components["schemas"]["milestone"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -53978,8 +55521,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request opened event */
"webhook-pull-request-opened": {
@@ -53989,7 +55532,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -54039,8 +55582,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request ready_for_review event */
"webhook-pull-request-ready-for-review": {
@@ -54050,7 +55593,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -54100,8 +55643,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request reopened event */
"webhook-pull-request-reopened": {
@@ -54111,7 +55654,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: components["schemas"]["pull-request"] & ({
/**
* @description Whether to allow auto-merge for pull requests.
@@ -54161,8 +55704,8 @@ export interface components {
*/
use_squash_pr_title_as_default?: boolean;
});
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment created event */
"webhook-pull-request-review-comment-created": {
@@ -54315,7 +55858,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -55433,8 +56976,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment deleted event */
"webhook-pull-request-review-comment-deleted": {
@@ -55587,7 +57130,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -56705,8 +58248,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_comment edited event */
"webhook-pull-request-review-comment-edited": {
@@ -56866,7 +58409,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
pull_request: {
_links: {
/** Link */
@@ -57984,8 +59527,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review dismissed event */
"webhook-pull-request-review-dismissed": {
@@ -57993,7 +59536,7 @@ export interface components {
action: "dismissed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -59112,7 +60655,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -59186,7 +60729,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review edited event */
"webhook-pull-request-review-edited": {
@@ -59200,7 +60743,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -60227,7 +61770,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -60300,7 +61843,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request review_request_removed event */
"webhook-pull-request-review-request-removed": OneOf<[{
@@ -60310,7 +61853,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -61481,7 +63024,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requested_reviewer: ({
/** Format: uri */
@@ -61519,7 +63062,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}, {
/** @enum {string} */
action: "review_request_removed";
@@ -61527,7 +63070,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -62705,7 +64248,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -62761,7 +64304,7 @@ export interface components {
*/
url: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}]>;
/** pull_request review_requested event */
"webhook-pull-request-review-requested": OneOf<[{
@@ -62771,7 +64314,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -63949,7 +65492,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
requested_reviewer: ({
/** Format: uri */
@@ -63987,7 +65530,7 @@ export interface components {
/** Format: uri */
url?: string;
}) | null;
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}, {
/** @enum {string} */
action: "review_requested";
@@ -63995,7 +65538,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -65173,7 +66716,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -65229,7 +66772,7 @@ export interface components {
*/
url?: string;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
}]>;
/** pull_request_review submitted event */
"webhook-pull-request-review-submitted": {
@@ -65237,7 +66780,7 @@ export interface components {
action: "submitted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -66356,7 +67899,7 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
review: {
_links: {
@@ -66429,7 +67972,7 @@ export interface components {
url?: string;
}) | null;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request_review_thread resolved event */
"webhook-pull-request-review-thread-resolved": {
@@ -66437,7 +67980,7 @@ export interface components {
action: "resolved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -67478,8 +69021,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
thread: {
comments: ({
_links: {
@@ -67631,7 +69174,7 @@ export interface components {
action: "unresolved";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
pull_request: {
_links: {
@@ -68672,8 +70215,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
thread: {
comments: ({
_links: {
@@ -68829,7 +70372,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -70000,8 +71543,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unassigned event */
"webhook-pull-request-unassigned": {
@@ -70048,7 +71591,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -71226,8 +72769,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unlabeled event */
"webhook-pull-request-unlabeled": {
@@ -71253,7 +72796,7 @@ export interface components {
};
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -72424,8 +73967,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** pull_request unlocked event */
"webhook-pull-request-unlocked": {
@@ -72435,7 +73978,7 @@ export interface components {
installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
number: number;
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
pull_request: {
_links: {
@@ -73613,8 +75156,8 @@ export interface components {
url?: string;
}) | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** push event */
"webhook-push": {
@@ -73735,7 +75278,7 @@ export interface components {
url: string;
}) | null;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Committer
* @description Metaproperties for Git author/committer information.
@@ -73993,14 +75536,14 @@ export interface components {
/** @description Whether to require contributors to sign off on web-based commits */
web_commit_signoff_required?: boolean;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
"webhook-registry-package-published": {
/** @enum {string} */
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
registry_package: {
created_at: string | null;
description: string | null;
@@ -74188,15 +75731,15 @@ export interface components {
} | null;
updated_at: string | null;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
"webhook-registry-package-updated": {
/** @enum {string} */
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
registry_package: {
created_at: string;
description: Record | null;
@@ -74321,8 +75864,8 @@ export interface components {
registry: Record | null;
updated_at: string;
};
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release created event */
"webhook-release-created": {
@@ -74330,7 +75873,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -74478,8 +76021,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release deleted event */
"webhook-release-deleted": {
@@ -74487,7 +76030,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -74635,8 +76178,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** release edited event */
"webhook-release-edited": {
@@ -74658,7 +76201,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -74806,8 +76349,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release prereleased event */
"webhook-release-prereleased": {
@@ -74815,7 +76358,7 @@ export interface components {
action: "prereleased";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -75001,8 +76544,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release published event */
"webhook-release-published": {
@@ -75010,7 +76553,7 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -75193,8 +76736,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release released event */
"webhook-release-released": {
@@ -75202,7 +76745,7 @@ export interface components {
action: "released";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
@@ -75350,8 +76893,8 @@ export interface components {
/** Format: uri */
zipball_url: string | null;
};
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** release unpublished event */
"webhook-release-unpublished": {
@@ -75359,7 +76902,7 @@ export interface components {
action: "unpublished";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
release: ({
assets: ({
/** Format: uri */
@@ -75541,8 +77084,8 @@ export interface components {
url?: string;
zipball_url?: string | null;
});
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Repository advisory published event */
"webhook-repository-advisory-published": {
@@ -75550,10 +77093,10 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
repository_advisory: components["schemas"]["repository-advisory"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Repository advisory reported event */
"webhook-repository-advisory-reported": {
@@ -75561,10 +77104,10 @@ export interface components {
action: "reported";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
repository_advisory: components["schemas"]["repository-advisory"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** repository archived event */
"webhook-repository-archived": {
@@ -75572,9 +77115,9 @@ export interface components {
action: "archived";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository created event */
"webhook-repository-created": {
@@ -75582,9 +77125,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository deleted event */
"webhook-repository-deleted": {
@@ -75592,9 +77135,9 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_dispatch event */
"webhook-repository-dispatch-sample": {
@@ -75606,9 +77149,9 @@ export interface components {
} | null;
enterprise?: components["schemas"]["enterprise"];
installation: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository edited event */
"webhook-repository-edited": {
@@ -75630,17 +77173,17 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_import event */
"webhook-repository-import": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @enum {string} */
status: "success" | "cancelled" | "failure";
};
@@ -75650,9 +77193,9 @@ export interface components {
action: "privatized";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository publicized event */
"webhook-repository-publicized": {
@@ -75660,9 +77203,9 @@ export interface components {
action: "publicized";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository renamed event */
"webhook-repository-renamed": {
@@ -75677,9 +77220,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset created event */
"webhook-repository-ruleset-created": {
@@ -75687,10 +77230,10 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset deleted event */
"webhook-repository-ruleset-deleted": {
@@ -75698,10 +77241,10 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository ruleset edited event */
"webhook-repository-ruleset-edited": {
@@ -75709,8 +77252,8 @@ export interface components {
action: "edited";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
repository_ruleset: components["schemas"]["repository-ruleset"];
changes?: {
name?: {
@@ -75759,7 +77302,7 @@ export interface components {
}[];
};
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository transferred event */
"webhook-repository-transferred": {
@@ -75835,9 +77378,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository unarchived event */
"webhook-repository-unarchived": {
@@ -75845,9 +77388,9 @@ export interface components {
action: "unarchived";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert create event */
"webhook-repository-vulnerability-alert-create": {
@@ -75927,9 +77470,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert dismiss event */
"webhook-repository-vulnerability-alert-dismiss": {
@@ -76050,9 +77593,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert reopen event */
"webhook-repository-vulnerability-alert-reopen": {
@@ -76132,9 +77675,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** repository_vulnerability_alert resolve event */
"webhook-repository-vulnerability-alert-resolve": {
@@ -76217,9 +77760,9 @@ export interface components {
});
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert created event */
"webhook-secret-scanning-alert-created": {
@@ -76228,9 +77771,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** Secret Scanning Alert Location Created Event */
"webhook-secret-scanning-alert-location-created": {
@@ -76239,9 +77782,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
installation?: components["schemas"]["simple-installation"];
location: components["schemas"]["secret-scanning-location"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** Secret Scanning Alert Location Created Event */
"webhook-secret-scanning-alert-location-created-form-encoded": {
@@ -76255,9 +77798,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert resolved event */
"webhook-secret-scanning-alert-resolved": {
@@ -76266,9 +77809,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** secret_scanning_alert revoked event */
"webhook-secret-scanning-alert-revoked": {
@@ -76277,9 +77820,9 @@ export interface components {
alert: components["schemas"]["secret-scanning-alert-webhook"];
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender?: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory published event */
"webhook-security-advisory-published": {
@@ -76287,8 +77830,8 @@ export interface components {
action: "published";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -76326,7 +77869,7 @@ export interface components {
})[];
withdrawn_at: string | null;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory updated event */
"webhook-security-advisory-updated": {
@@ -76334,8 +77877,8 @@ export interface components {
action: "updated";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -76373,7 +77916,7 @@ export interface components {
})[];
withdrawn_at: string | null;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_advisory withdrawn event */
"webhook-security-advisory-withdrawn": {
@@ -76381,8 +77924,8 @@ export interface components {
action: "withdrawn";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
security_advisory: {
cvss: {
@@ -76420,7 +77963,7 @@ export interface components {
})[];
withdrawn_at: string;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** security_and_analysis event */
"webhook-security-and-analysis": {
@@ -76431,9 +77974,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
repository: components["schemas"]["full-repository"];
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
};
/** sponsorship cancelled event */
"webhook-sponsorship-cancelled": {
@@ -76441,9 +77984,9 @@ export interface components {
action: "cancelled";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -76565,9 +78108,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -76695,9 +78238,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -76821,9 +78364,9 @@ export interface components {
effective_date?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -76966,9 +78509,9 @@ export interface components {
effective_date?: string;
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -77109,9 +78652,9 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository?: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
sponsorship: {
created_at: string;
maintainer?: {
@@ -77233,9 +78776,9 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */
starred_at: string | null;
};
@@ -77245,9 +78788,9 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. */
starred_at: Record | null;
};
@@ -77409,9 +78952,9 @@ export interface components {
id: number;
installation?: components["schemas"]["simple-installation"];
name: string;
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** @description The Commit SHA. */
sha: string;
/**
@@ -77427,9 +78970,9 @@ export interface components {
"webhook-team-add": {
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -77502,7 +79045,7 @@ export interface components {
action: "added_to_repository";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -77738,7 +79281,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -77811,7 +79354,7 @@ export interface components {
action: "created";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -78047,7 +79590,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -78120,7 +79663,7 @@ export interface components {
action: "deleted";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -78356,7 +79899,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -78460,7 +80003,7 @@ export interface components {
};
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -78696,7 +80239,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -78769,7 +80312,7 @@ export interface components {
action: "removed_from_repository";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization: components["schemas"]["organization-simple"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
@@ -79005,7 +80548,7 @@ export interface components {
watchers: number;
watchers_count: number;
};
- sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
@@ -79078,9 +80621,9 @@ export interface components {
action: "started";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
};
/** workflow_dispatch event */
"webhook-workflow-dispatch": {
@@ -79089,10 +80632,10 @@ export interface components {
[key: string]: unknown;
} | null;
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
ref: string;
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow: string;
};
/** workflow_job completed event */
@@ -79101,9 +80644,9 @@ export interface components {
action: "completed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: ({
/** Format: uri */
check_run_url: string;
@@ -79191,9 +80734,9 @@ export interface components {
action: "in_progress";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: ({
/** Format: uri */
check_run_url: string;
@@ -79289,9 +80832,9 @@ export interface components {
action: "queued";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: {
/** Format: uri */
check_run_url: string;
@@ -79343,9 +80886,9 @@ export interface components {
action: "waiting";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
workflow_job: {
/** Format: uri */
check_run_url: string;
@@ -79397,9 +80940,9 @@ export interface components {
action: "completed";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -80084,9 +81627,9 @@ export interface components {
action: "in_progress";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -80771,9 +82314,9 @@ export interface components {
action: "requested";
enterprise?: components["schemas"]["enterprise"];
installation?: components["schemas"]["simple-installation"];
- organization?: components["schemas"]["organization-simple"];
- repository: components["schemas"]["repository"];
- sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user-webhooks"];
/** Workflow */
workflow: {
/** Format: uri */
@@ -81428,6 +82971,10 @@ export interface components {
/** @description The client ID of the GitHub app. */
"client-id": string;
"app-slug": string;
+ /** @description The unique identifier of the classroom assignment. */
+ "assignment-id": number;
+ /** @description The unique identifier of the classroom. */
+ "classroom-id": number;
/** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
enterprise: string;
/**
@@ -82357,6 +83904,132 @@ export interface operations {
404: components["responses"]["not_found"];
};
};
+ /**
+ * Get an assignment
+ * @description Gets a GitHub Classroom assignment. Assignment will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-an-assignment": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List accepted assignments for an assignment
+ * @description Lists any assignment repositories that have been created by students accepting a GitHub Classroom assignment. Accepted assignments will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/list-accepted-assigments-for-an-assignment": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-accepted-assignment"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get assignment grades
+ * @description Gets grades for a GitHub Classroom assignment. Grades will only be returned if the current user is an administrator of the GitHub Classroom for the assignment.
+ */
+ "classroom/get-assignment-grades": {
+ parameters: {
+ path: {
+ assignment_id: components["parameters"]["assignment-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom-assignment-grade"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List classrooms
+ * @description Lists GitHub Classroom classrooms for the current user. Classrooms will only be returned if the current user is an administrator of one or more GitHub Classrooms.
+ */
+ "classroom/list-classrooms": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom"][];
+ };
+ };
+ };
+ };
+ /**
+ * Get a classroom
+ * @description Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/get-a-classroom": {
+ parameters: {
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["classroom"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ /**
+ * List assignments for a classroom
+ * @description Lists GitHub Classroom assignments for a classroom. Assignments will only be returned if the current user is an administrator of the GitHub Classroom.
+ */
+ "classroom/list-assignments-for-a-classroom": {
+ parameters: {
+ query?: {
+ page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
+ };
+ path: {
+ classroom_id: components["parameters"]["classroom-id"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["simple-classroom-assignment"][];
+ };
+ };
+ };
+ };
/**
* Get all codes of conduct
* @description Returns array of all GitHub's codes of conduct.
@@ -82703,6 +84376,7 @@ export interface operations {
/**
* Update a gist
* @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ * At least one of `description` or `files` is required.
*/
"gists/update": {
parameters: {
@@ -82722,7 +84396,8 @@ export interface operations {
* @description The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
* (including extension) of the targeted gist file. For example: `hello.py`.
*
- * To delete a file, set the whole file to null. For example: `hello.py : null`.
+ * To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be
+ * deleted if the specified object does not contain at least one of `content` or `filename`.
* @example {
* "hello.rb": {
* "content": "blah",
@@ -84277,6 +85952,8 @@ export interface operations {
"actions/list-self-hosted-runners-for-org": {
parameters: {
query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
};
@@ -91441,6 +93118,8 @@ export interface operations {
"actions/list-self-hosted-runners-for-repo": {
parameters: {
query?: {
+ /** @description The name of a self-hosted runner. */
+ name?: string;
per_page?: components["parameters"]["per-page"];
page?: components["parameters"]["page"];
};
@@ -97372,11 +99051,8 @@ export interface operations {
* @default
*/
description?: string;
- /**
- * @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.
- * @enum {string}
- */
- environment?: "production" | "staging" | "qa";
+ /** @description Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. */
+ environment?: string;
/**
* @description Sets the URL for accessing your environment. Default: `""`
* @default
@@ -103121,9 +104797,10 @@ export interface operations {
};
/**
* Get rules for a branch
- * @description Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- * branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- * are configured.
+ * @description Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ * to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ * at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ * enforcement statuses are not returned.
*/
"repos/get-branch-rules": {
parameters: {
diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml
index c3b3c3ee4..443e4d5fc 100644
--- a/packages/openapi-typescript/examples/github-api.yaml
+++ b/packages/openapi-typescript/examples/github-api.yaml
@@ -83,6 +83,8 @@ tags:
description: Manage security advisories.
- name: interactions
description: Owner or admin management of users interactions.
+- name: classroom
+ description: Interact with GitHub Classroom.
servers:
- url: https://api.github.com
externalDocs:
@@ -1140,6 +1142,193 @@ paths:
enabledForGitHubApps: true
category: apps
subcategory: apps
+ "/assignments/{assignment_id}":
+ get:
+ summary: Get an assignment
+ description: Gets a GitHub Classroom assignment. Assignment will only be returned
+ if the current user is an administrator of the GitHub Classroom for the assignment.
+ tags:
+ - classroom
+ operationId: classroom/get-an-assignment
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-an-assignment
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/classroom-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-assignment"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/assignments/{assignment_id}/accepted_assignments":
+ get:
+ summary: List accepted assignments for an assignment
+ description: Lists any assignment repositories that have been created by students
+ accepting a GitHub Classroom assignment. Accepted assignments will only be
+ returned if the current user is an administrator of the GitHub Classroom for
+ the assignment.
+ tags:
+ - classroom
+ operationId: classroom/list-accepted-assigments-for-an-assignment
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/classroom-accepted-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-accepted-assignment"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/assignments/{assignment_id}/grades":
+ get:
+ summary: Get assignment grades
+ description: Gets grades for a GitHub Classroom assignment. Grades will only
+ be returned if the current user is an administrator of the GitHub Classroom
+ for the assignment.
+ tags:
+ - classroom
+ operationId: classroom/get-assignment-grades
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades
+ parameters:
+ - "$ref": "#/components/parameters/assignment-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/classroom-assignment-grade"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom-assignment-grades"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms":
+ get:
+ summary: List classrooms
+ description: Lists GitHub Classroom classrooms for the current user. Classrooms
+ will only be returned if the current user is an administrator of one or more
+ GitHub Classrooms.
+ tags:
+ - classroom
+ operationId: classroom/list-classrooms
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-classrooms
+ parameters:
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom"
+ examples:
+ default:
+ "$ref": "#/components/examples/simple-classroom"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms/{classroom_id}":
+ get:
+ summary: Get a classroom
+ description: Gets a GitHub Classroom classroom for the current user. Classroom
+ will only be returned if the current user is an administrator of the GitHub
+ Classroom.
+ tags:
+ - classroom
+ operationId: classroom/get-a-classroom
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#get-a-classroom
+ parameters:
+ - "$ref": "#/components/parameters/classroom-id"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ "$ref": "#/components/schemas/classroom"
+ examples:
+ default:
+ "$ref": "#/components/examples/classroom"
+ '404':
+ "$ref": "#/components/responses/not_found"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
+ "/classrooms/{classroom_id}/assignments":
+ get:
+ summary: List assignments for a classroom
+ description: Lists GitHub Classroom assignments for a classroom. Assignments
+ will only be returned if the current user is an administrator of the GitHub
+ Classroom.
+ tags:
+ - classroom
+ operationId: classroom/list-assignments-for-a-classroom
+ externalDocs:
+ description: API method documentation
+ url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
+ parameters:
+ - "$ref": "#/components/parameters/classroom-id"
+ - "$ref": "#/components/parameters/page"
+ - "$ref": "#/components/parameters/per-page"
+ responses:
+ '200':
+ description: Response
+ content:
+ application/json:
+ schema:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ examples:
+ default:
+ "$ref": "#/components/examples/simple-classroom-assignment"
+ x-github:
+ enabledForGitHubApps: true
+ category: classroom
+ subcategory: classroom
"/codes_of_conduct":
get:
summary: Get all codes of conduct
@@ -1657,9 +1846,9 @@ paths:
subcategory: gists
patch:
summary: Update a gist
- description: Allows you to update a gist's description and to update, delete,
- or rename gist files. Files from the previous version of the gist that aren't
- explicitly changed during an edit are unchanged.
+ description: |-
+ Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.
+ At least one of `description` or `files` is required.
tags:
- gists
operationId: gists/update
@@ -1683,7 +1872,8 @@ paths:
The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
(including extension) of the targeted gist file. For example: `hello.py`.
- To delete a file, set the whole file to null. For example: `hello.py : null`.
+ To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be
+ deleted if the specified object does not contain at least one of `content` or `filename`.
example:
hello.rb:
content: blah
@@ -1700,18 +1890,6 @@ paths:
description: The new filename for the file.
type: string
nullable: true
- anyOf:
- - required:
- - content
- - required:
- - filename
- - type: object
- maxProperties: 0
- anyOf:
- - required:
- - description
- - required:
- - files
type: object
nullable: true
examples:
@@ -4159,6 +4337,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-organization
parameters:
+ - name: name
+ description: The name of a self-hosted runner.
+ in: query
+ schema:
+ type: string
- "$ref": "#/components/parameters/org"
- "$ref": "#/components/parameters/per-page"
- "$ref": "#/components/parameters/page"
@@ -14804,6 +14987,11 @@ paths:
description: API method documentation
url: https://docs.github.com/rest/actions/self-hosted-runners#list-self-hosted-runners-for-a-repository
parameters:
+ - name: name
+ description: The name of a self-hosted runner.
+ in: query
+ schema:
+ type: string
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/per-page"
@@ -21328,7 +21516,7 @@ paths:
nullable: true
examples:
default:
- "$ref": "#/components/examples/codespaces-list-devcontainers-for-repository"
+ "$ref": "#/components/examples/codespaces-default-attributes-for-a-codespace"
'401':
"$ref": "#/components/responses/requires_authentication"
'403':
@@ -24091,11 +24279,9 @@ paths:
type: string
description: Name for the target deployment environment, which can
be changed when setting a deploy status. For example, `production`,
- `staging`, or `qa`.
- enum:
- - production
- - staging
- - qa
+ `staging`, or `qa`. If not defined, the environment of the previous
+ status on the deployment will be used, if it exists. Otherwise,
+ the environment of the deployment will be used.
environment_url:
type: string
description: 'Sets the URL for accessing your environment. Default:
@@ -24655,7 +24841,8 @@ paths:
type: array
items:
"$ref": "#/components/schemas/deployment-protection-rule"
- example: "../../components/examples/deployment_protection_rules.yaml"
+ example:
+ "$ref": "#/components/examples/deployment-protection-rules"
examples:
default:
value:
@@ -33095,9 +33282,10 @@ paths:
get:
summary: Get rules for a branch
description: |-
- Returns all rules that apply to the specified branch. The branch does not need to exist; rules that would apply to a
- branch with that name will be returned. All rules that apply will be returned, regardless of the level at which they
- are configured.
+ Returns all active rules that apply to the specified branch. The branch does not need to exist; rules that would apply
+ to a branch with that name will be returned. All active rules that apply will be returned, regardless of the level
+ at which they are configured (e.g. repository or organization). Rules in rulesets with "evaluate" or "disabled"
+ enforcement statuses are not returned.
tags:
- repos
operationId: repos/get-branch-rules
@@ -43516,7 +43704,7 @@ x-webhooks:
description: All branch protections were disabled for a repository.
operationId: branch-protection-configuration/disabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-configuration
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration
parameters:
- name: User-Agent
in: header
@@ -43566,7 +43754,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-configuration
+ subcategory: branch_protection_configuration
supported-webhook-types:
- repository
- organization
@@ -43582,7 +43770,7 @@ x-webhooks:
description: All branch protections were enabled for a repository.
operationId: branch-protection-configuration/enabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-configuration
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_configuration
parameters:
- name: User-Agent
in: header
@@ -43632,7 +43820,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-configuration
+ subcategory: branch_protection_configuration
supported-webhook-types:
- repository
- organization
@@ -43646,7 +43834,7 @@ x-webhooks:
description: A branch protection rule was created.
operationId: branch-protection-rule/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43696,7 +43884,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -43710,7 +43898,7 @@ x-webhooks:
description: A branch protection rule was deleted.
operationId: branch-protection-rule/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43760,7 +43948,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -43774,7 +43962,7 @@ x-webhooks:
description: A branch protection rule was edited.
operationId: branch-protection-rule/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch-protection-rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
@@ -43824,7 +44012,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: branch-protection-rule
+ subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
@@ -43844,7 +44032,7 @@ x-webhooks:
description: A check run was completed, and a conclusion is available.
operationId: check-run/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -43924,7 +44112,7 @@ x-webhooks:
description: A new check run was created.
operationId: check-run/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44007,7 +44195,7 @@ x-webhooks:
see "[Creating CI tests with the Checks API](https://docs.github.com/developers/apps/guides/creating-ci-tests-with-the-checks-api)."
operationId: check-run/requested-action
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44088,7 +44276,7 @@ x-webhooks:
someone requests to re-run the check will receive the `rerequested` payload.
operationId: check-run/rerequested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check_run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
@@ -44160,7 +44348,7 @@ x-webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44169,7 +44357,7 @@ x-webhooks:
is available.
operationId: check-suite/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44219,7 +44407,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44231,7 +44419,7 @@ x-webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44243,7 +44431,7 @@ x-webhooks:
in the REST API documentation.
operationId: check-suite/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44293,7 +44481,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44305,7 +44493,7 @@ x-webhooks:
For activity relating to check runs, use the `check_run` event.
- To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at lease write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
+ To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
@@ -44317,7 +44505,7 @@ x-webhooks:
in the REST API documentation.
operationId: check-suite/rerequested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#check-suite
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
@@ -44367,7 +44555,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: check-suite
+ subcategory: check_suite
supported-webhook-types:
- repository
- organization
@@ -44383,7 +44571,7 @@ x-webhooks:
a pre-existing code scanning alert.
operationId: code-scanning-alert/appeared-in-branch
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44433,7 +44621,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44447,7 +44635,7 @@ x-webhooks:
description: Someone closed a code scanning alert.
operationId: code-scanning-alert/closed-by-user
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44497,7 +44685,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44511,7 +44699,7 @@ x-webhooks:
description: A code scanning alert was created in a repository.
operationId: code-scanning-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44561,7 +44749,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44575,7 +44763,7 @@ x-webhooks:
description: A code scanning alert was fixed in a branch by a commit.
operationId: code-scanning-alert/fixed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44625,7 +44813,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44639,7 +44827,7 @@ x-webhooks:
description: A previously fixed code scanning alert reappeared in a branch.
operationId: code-scanning-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44689,7 +44877,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44703,7 +44891,7 @@ x-webhooks:
description: Someone reopened a code scanning alert.
operationId: code-scanning-alert/reopened-by-user
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#code-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -44753,7 +44941,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: code-scanning-alert
+ subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -44769,7 +44957,7 @@ x-webhooks:
description: Someone commented on a commit.
operationId: commit-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#commit-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#commit_comment
parameters:
- name: User-Agent
in: header
@@ -44819,7 +45007,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: commit-comment
+ subcategory: commit_comment
supported-webhook-types:
- repository
- organization
@@ -44834,7 +45022,7 @@ x-webhooks:
**Note**: This event will not occur when more than three tags are created at once.
operationId: create
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#create
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#create
parameters:
- name: User-Agent
in: header
@@ -44892,14 +45080,15 @@ x-webhooks:
delete:
post:
summary: |-
- This event occurs when a Git branch or tag is deleted.
+ This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
+ branch and tag deletions, use the [`push`](#push) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: This event will not occur when more than three tags are deleted at once.
operationId: delete
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delete
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#delete
parameters:
- name: User-Agent
in: header
@@ -44967,7 +45156,7 @@ x-webhooks:
description: A Dependabot alert was automatically closed.
operationId: dependabot-alert/auto-dismissed
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45017,7 +45206,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45035,7 +45224,7 @@ x-webhooks:
description: A Dependabot alert was automatically reopened.
operationId: dependabot-alert/auto-reopened
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45085,7 +45274,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45105,7 +45294,7 @@ x-webhooks:
to be vulnerable.
operationId: dependabot-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45155,7 +45344,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45173,7 +45362,7 @@ x-webhooks:
description: A Dependabot alert was manually closed.
operationId: dependabot-alert/dismissed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45223,7 +45412,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45241,7 +45430,7 @@ x-webhooks:
description: A manifest file change removed a vulnerability.
operationId: dependabot-alert/fixed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45291,7 +45480,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45310,7 +45499,7 @@ x-webhooks:
had previously been fixed.
operationId: dependabot-alert/reintroduced
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45360,7 +45549,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45378,7 +45567,7 @@ x-webhooks:
description: A Dependabot alert was manually reopened.
operationId: dependabot-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
@@ -45428,7 +45617,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: dependabot-alert
+ subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
@@ -45442,7 +45631,7 @@ x-webhooks:
description: A deploy key was created.
operationId: deploy-key/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
@@ -45492,7 +45681,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deploy-key
+ subcategory: deploy_key
supported-webhook-types:
- repository
- organization
@@ -45506,7 +45695,7 @@ x-webhooks:
description: A deploy key was deleted.
operationId: deploy-key/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
@@ -45556,7 +45745,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deploy-key
+ subcategory: deploy_key
supported-webhook-types:
- repository
- organization
@@ -45572,7 +45761,7 @@ x-webhooks:
description: A deployment was created.
operationId: deployment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment
parameters:
- name: User-Agent
in: header
@@ -45636,7 +45825,7 @@ x-webhooks:
description: A deployment protection rule was requested for an environment.
operationId: deployment-protection-rule/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_protection_rule
parameters:
- name: User-Agent
in: header
@@ -45686,7 +45875,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-protection-rule
+ subcategory: deployment_protection_rule
supported-webhook-types:
- app
deployment-review-approved:
@@ -45700,7 +45889,7 @@ x-webhooks:
description: A deployment review was approved.
operationId: deployment-review/approved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -45750,7 +45939,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-rejected:
@@ -45764,7 +45953,7 @@ x-webhooks:
description: A deployment review was rejected.
operationId: deployment-review/rejected
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -45814,7 +46003,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-requested:
@@ -45828,7 +46017,7 @@ x-webhooks:
description: A deployment review was requested.
operationId: deployment-review/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
@@ -45878,7 +46067,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-review
+ subcategory: deployment_review
supported-webhook-types:
- app
deployment-status-created:
@@ -45892,7 +46081,7 @@ x-webhooks:
description: A new deployment status was created.
operationId: deployment-status/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment-status
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#deployment_status
parameters:
- name: User-Agent
in: header
@@ -45942,7 +46131,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: deployment-status
+ subcategory: deployment_status
supported-webhook-types:
- repository
- organization
@@ -45960,7 +46149,7 @@ x-webhooks:
description: A comment on the discussion was marked as the answer.
operationId: discussion/answered
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46028,7 +46217,7 @@ x-webhooks:
description: The category of a discussion was changed.
operationId: discussion/category-changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46096,7 +46285,7 @@ x-webhooks:
description: A discussion was closed.
operationId: discussion/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46164,7 +46353,7 @@ x-webhooks:
description: A comment on a discussion was created.
operationId: discussion-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46214,7 +46403,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46232,7 +46421,7 @@ x-webhooks:
description: A comment on a discussion was deleted.
operationId: discussion-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46282,7 +46471,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46300,7 +46489,7 @@ x-webhooks:
description: A comment on a discussion was edited.
operationId: discussion-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
@@ -46350,7 +46539,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: discussion-comment
+ subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
@@ -46368,7 +46557,7 @@ x-webhooks:
description: A discussion was created.
operationId: discussion/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46436,7 +46625,7 @@ x-webhooks:
description: A discussion was deleted.
operationId: discussion/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46505,7 +46694,7 @@ x-webhooks:
the discussion was changed.
operationId: discussion/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46573,7 +46762,7 @@ x-webhooks:
description: A label was added to a discussion.
operationId: discussion/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46641,7 +46830,7 @@ x-webhooks:
description: A discussion was locked.
operationId: discussion/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46709,7 +46898,7 @@ x-webhooks:
description: A discussion was pinned.
operationId: discussion/pinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46777,7 +46966,7 @@ x-webhooks:
description: A discussion was reopened.
operationId: discussion/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46845,7 +47034,7 @@ x-webhooks:
description: A discussion was transferred to another repository.
operationId: discussion/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46913,7 +47102,7 @@ x-webhooks:
description: A comment on the discussion was unmarked as the answer.
operationId: discussion/unanswered
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -46981,7 +47170,7 @@ x-webhooks:
description: A label was removed from a discussion.
operationId: discussion/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47049,7 +47238,7 @@ x-webhooks:
description: A discussion was unlocked.
operationId: discussion/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47117,7 +47306,7 @@ x-webhooks:
description: A discussion was unpinned.
operationId: discussion/unpinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#discussion
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
@@ -47180,7 +47369,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: fork
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#fork
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#fork
parameters:
- name: User-Agent
in: header
@@ -47247,7 +47436,7 @@ x-webhooks:
description: Someone revoked their authorization of a GitHub App.
operationId: github-app-authorization/revoked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#github-app-authorization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#github_app_authorization
parameters:
- name: User-Agent
in: header
@@ -47297,7 +47486,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: github-app-authorization
+ subcategory: github_app_authorization
supported-webhook-types:
- app
gollum:
@@ -47308,7 +47497,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: gollum
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#gollum
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#gollum
parameters:
- name: User-Agent
in: header
@@ -47372,7 +47561,7 @@ x-webhooks:
description: Someone installed a GitHub App on a user or organization account.
operationId: installation/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47435,7 +47624,7 @@ x-webhooks:
account.
operationId: installation/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47497,7 +47686,7 @@ x-webhooks:
description: Someone granted new permissions to a GitHub App.
operationId: installation/new-permissions-accepted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47559,7 +47748,7 @@ x-webhooks:
description: A GitHub App installation was granted access to one or more repositories.
operationId: installation-repositories/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
@@ -47609,7 +47798,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-repositories
+ subcategory: installation_repositories
supported-webhook-types:
- app
installation-repositories-removed:
@@ -47622,7 +47811,7 @@ x-webhooks:
installation.
operationId: installation-repositories/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-repositories
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
@@ -47672,7 +47861,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-repositories
+ subcategory: installation_repositories
supported-webhook-types:
- app
installation-suspend:
@@ -47685,7 +47874,7 @@ x-webhooks:
account.
operationId: installation/suspend
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47750,7 +47939,7 @@ x-webhooks:
App is installed on.
operationId: installation-target/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation-target
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation_target
parameters:
- name: User-Agent
in: header
@@ -47800,7 +47989,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: installation-target
+ subcategory: installation_target
supported-webhook-types:
- app
installation-unsuspend:
@@ -47813,7 +48002,7 @@ x-webhooks:
account was given access the account again.
operationId: installation/unsuspend
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#installation
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
@@ -47877,7 +48066,7 @@ x-webhooks:
description: A comment on an issue or pull request was created.
operationId: issue-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -47927,7 +48116,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -47943,7 +48132,7 @@ x-webhooks:
description: A comment on an issue or pull request was deleted.
operationId: issue-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -47993,7 +48182,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -48009,7 +48198,7 @@ x-webhooks:
description: A comment on an issue or pull request was edited.
operationId: issue-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issue-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
@@ -48059,7 +48248,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: issue-comment
+ subcategory: issue_comment
supported-webhook-types:
- repository
- organization
@@ -48075,7 +48264,7 @@ x-webhooks:
description: An issue was assigned to a user.
operationId: issues/assigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48141,7 +48330,7 @@ x-webhooks:
description: An issue was closed.
operationId: issues/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48207,7 +48396,7 @@ x-webhooks:
description: An issue was deleted.
operationId: issues/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48273,7 +48462,7 @@ x-webhooks:
description: An issue was removed from a milestone.
operationId: issues/demilestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48339,7 +48528,7 @@ x-webhooks:
description: The title or body on an issue was edited.
operationId: issues/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48405,7 +48594,7 @@ x-webhooks:
description: A label was added to an issue.
operationId: issues/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48472,7 +48661,7 @@ x-webhooks:
"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48538,7 +48727,7 @@ x-webhooks:
description: An issue was added to a milestone.
operationId: issues/milestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48605,7 +48794,7 @@ x-webhooks:
will be `reopened` instead.
operationId: issues/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48672,7 +48861,7 @@ x-webhooks:
"[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/pinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48738,7 +48927,7 @@ x-webhooks:
description: A closed issue was reopened.
operationId: issues/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48805,7 +48994,7 @@ x-webhooks:
see "[Transferring an issue to another repository](https://docs.github.com/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)."
operationId: issues/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48871,7 +49060,7 @@ x-webhooks:
description: A user was unassigned from an issue.
operationId: issues/unassigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -48937,7 +49126,7 @@ x-webhooks:
description: A label was removed from an issue.
operationId: issues/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49004,7 +49193,7 @@ x-webhooks:
"[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49071,7 +49260,7 @@ x-webhooks:
see "[Pinning an issue to your repository](https://docs.github.com/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/unpinned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#issues
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
@@ -49137,7 +49326,7 @@ x-webhooks:
description: A label was created.
operationId: label/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49203,7 +49392,7 @@ x-webhooks:
description: A label was deleted.
operationId: label/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49269,7 +49458,7 @@ x-webhooks:
description: A label's name, description, or color was changed.
operationId: label/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#label
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
@@ -49336,7 +49525,7 @@ x-webhooks:
cycle has ended. The change will take effect on the account immediately.
operationId: marketplace-purchase/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49386,7 +49575,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-changed:
@@ -49401,7 +49590,7 @@ x-webhooks:
last billing cycle has ended. The change will take effect on the account immediately.
operationId: marketplace-purchase/changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49451,7 +49640,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-pending-change:
@@ -49468,7 +49657,7 @@ x-webhooks:
be sent.
operationId: marketplace-purchase/pending-change
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49518,7 +49707,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-pending-change-cancelled:
@@ -49534,7 +49723,7 @@ x-webhooks:
at the end of a billing cycle.
operationId: marketplace-purchase/pending-change-cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49584,7 +49773,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
marketplace-purchase-purchased:
@@ -49599,7 +49788,7 @@ x-webhooks:
effect on the account immediately.
operationId: marketplace-purchase/purchased
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#marketplace-purchase
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#marketplace_purchase
parameters:
- name: User-Agent
in: header
@@ -49649,7 +49838,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: marketplace-purchase
+ subcategory: marketplace_purchase
supported-webhook-types:
- marketplace
member-added:
@@ -49661,7 +49850,7 @@ x-webhooks:
description: A GitHub user accepted an invitation to a repository.
operationId: member/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -49726,7 +49915,7 @@ x-webhooks:
description: Permissions were changed for a collaborator on a repository.
operationId: member/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -49791,7 +49980,7 @@ x-webhooks:
description: A collaborator was removed from a repository.
operationId: member/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#member
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
@@ -49856,7 +50045,7 @@ x-webhooks:
description: An organization member was added to a team.
operationId: membership/added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
@@ -49920,7 +50109,7 @@ x-webhooks:
description: An organization member was removed from a team.
operationId: membership/removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#membership
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
@@ -49989,7 +50178,7 @@ x-webhooks:
tags:
- merge-queue
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group
parameters:
- name: User-Agent
in: header
@@ -50039,7 +50228,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: merge-group
+ subcategory: merge_group
supported-webhook-types:
- app
merge-group-destroyed:
@@ -50056,7 +50245,7 @@ x-webhooks:
tags:
- merge-queue
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#merge-group
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#merge_group
parameters:
- name: User-Agent
in: header
@@ -50106,7 +50295,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: merge-group
+ subcategory: merge_group
supported-webhook-types:
- app
meta-deleted:
@@ -50118,7 +50307,7 @@ x-webhooks:
description: The webhook was deleted.
operationId: meta/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#meta
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#meta
parameters:
- name: User-Agent
in: header
@@ -50186,7 +50375,7 @@ x-webhooks:
description: A milestone was closed.
operationId: milestone/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50252,7 +50441,7 @@ x-webhooks:
description: A milestone was created.
operationId: milestone/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50318,7 +50507,7 @@ x-webhooks:
description: A milestone was deleted.
operationId: milestone/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50384,7 +50573,7 @@ x-webhooks:
description: A milestone was edited.
operationId: milestone/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50450,7 +50639,7 @@ x-webhooks:
description: A milestone was opened.
operationId: milestone/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#milestone
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
@@ -50516,7 +50705,7 @@ x-webhooks:
description: A user was blocked from the organization.
operationId: org-block/blocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block
parameters:
- name: User-Agent
in: header
@@ -50566,7 +50755,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: org-block
+ subcategory: org_block
supported-webhook-types:
- organization
- business
@@ -50582,7 +50771,7 @@ x-webhooks:
description: A previously blocked user was unblocked from the organization.
operationId: org-block/unblocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#org-block
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#org_block
parameters:
- name: User-Agent
in: header
@@ -50632,7 +50821,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: org-block
+ subcategory: org_block
supported-webhook-types:
- organization
- business
@@ -50648,7 +50837,7 @@ x-webhooks:
description: An organization was deleted.
operationId: organization/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50714,7 +50903,7 @@ x-webhooks:
description: A member accepted an invitation to join an organization.
operationId: organization/member-added
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50780,7 +50969,7 @@ x-webhooks:
description: A member was invited to join the organization.
operationId: organization/member-invited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50846,7 +51035,7 @@ x-webhooks:
description: A member was removed from the organization.
operationId: organization/member-removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50912,7 +51101,7 @@ x-webhooks:
description: The name of an organization was changed.
operationId: organization/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#organization
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
@@ -50976,7 +51165,7 @@ x-webhooks:
description: A package was published to a registry.
operationId: package/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
@@ -51040,7 +51229,7 @@ x-webhooks:
description: A previously published package was updated.
operationId: package/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
@@ -51103,7 +51292,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.
operationId: page-build
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#page-build
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#page_build
parameters:
- name: User-Agent
in: header
@@ -51153,7 +51342,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: page-build
+ subcategory: page_build
supported-webhook-types:
- repository
- organization
@@ -51169,7 +51358,7 @@ x-webhooks:
description: A fine-grained personal access token request was approved.
operationId: personal-access-token-request/approved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51219,7 +51408,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-cancelled:
@@ -51234,7 +51423,7 @@ x-webhooks:
requester.
operationId: personal-access-token-request/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51284,7 +51473,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-created:
@@ -51298,7 +51487,7 @@ x-webhooks:
description: A fine-grained personal access token request was created.
operationId: personal-access-token-request/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51348,7 +51537,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
personal-access-token-request-denied:
@@ -51362,7 +51551,7 @@ x-webhooks:
description: A fine-grained personal access token request was denied.
operationId: personal-access-token-request/denied
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#personal-access-token-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#personal_access_token_request
parameters:
- name: User-Agent
in: header
@@ -51412,7 +51601,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: personal-access-token-request
+ subcategory: personal_access_token_request
supported-webhook-types:
- app
ping:
@@ -51421,7 +51610,7 @@ x-webhooks:
a confirmation from GitHub that you configured the webhook correctly.
operationId: ping
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#ping
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#ping
parameters:
- name: User-Agent
in: header
@@ -51499,7 +51688,7 @@ x-webhooks:
description: A note in a classic project was converted to an issue.
operationId: project-card/converted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51549,7 +51738,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51565,7 +51754,7 @@ x-webhooks:
description: A card was added to a classic project.
operationId: project-card/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51615,7 +51804,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51631,7 +51820,7 @@ x-webhooks:
description: A card on a classic project was deleted.
operationId: project-card/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51681,7 +51870,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51697,7 +51886,7 @@ x-webhooks:
description: A note on a classic project was edited.
operationId: project-card/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51747,7 +51936,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51764,7 +51953,7 @@ x-webhooks:
position in its column.
operationId: project-card/moved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-card
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
@@ -51814,7 +52003,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-card
+ subcategory: project_card
supported-webhook-types:
- repository
- organization
@@ -51830,7 +52019,7 @@ x-webhooks:
description: A classic project was closed.
operationId: project/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -51896,7 +52085,7 @@ x-webhooks:
description: A column was added to a classic project.
operationId: project-column/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -51946,7 +52135,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -51962,7 +52151,7 @@ x-webhooks:
description: A column was deleted from a classic project.
operationId: project-column/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52012,7 +52201,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52028,7 +52217,7 @@ x-webhooks:
description: The name of a column on a classic project was changed.
operationId: project-column/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52078,7 +52267,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52094,7 +52283,7 @@ x-webhooks:
description: A column was moved to a new position on a classic project.
operationId: project-column/moved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project-column
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
@@ -52144,7 +52333,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: project-column
+ subcategory: project_column
supported-webhook-types:
- repository
- organization
@@ -52160,7 +52349,7 @@ x-webhooks:
description: A classic project was created.
operationId: project/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52226,7 +52415,7 @@ x-webhooks:
description: A classic project was deleted.
operationId: project/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52292,7 +52481,7 @@ x-webhooks:
description: The name or description of a classic project was changed.
operationId: project/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52358,7 +52547,7 @@ x-webhooks:
description: A classic project was closed.
operationId: project/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#project
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
@@ -52426,7 +52615,7 @@ x-webhooks:
description: A project in the organization was closed.
operationId: projects-v2/closed
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52493,7 +52682,7 @@ x-webhooks:
description: A project in the organization was created.
operationId: projects-v2/created
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52560,7 +52749,7 @@ x-webhooks:
description: A project in the organization was deleted.
operationId: projects-v2/deleted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52628,7 +52817,7 @@ x-webhooks:
was changed.
operationId: projects-v2/edited
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -52696,7 +52885,7 @@ x-webhooks:
see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/archived
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52763,7 +52952,7 @@ x-webhooks:
description: A draft issue in an organization project was converted to an issue.
operationId: projects-v2-item/converted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52830,7 +53019,7 @@ x-webhooks:
description: An item was added to a project in the organization.
operationId: projects-v2-item/created
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52897,7 +53086,7 @@ x-webhooks:
description: An item was deleted from a project in the organization.
operationId: projects-v2-item/deleted
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -52966,7 +53155,7 @@ x-webhooks:
issue was changed, or a draft issue was converted to an issue.
operationId: projects-v2-item/edited
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53035,7 +53224,7 @@ x-webhooks:
board layout.
operationId: projects-v2-item/reordered
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53103,7 +53292,7 @@ x-webhooks:
archive. For more information, see "[Archiving items from your project](https://docs.github.com/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/restored
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
@@ -53170,7 +53359,7 @@ x-webhooks:
description: A project in the organization was reopened.
operationId: projects-v2/reopened
externalDocs:
- url: ''
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
@@ -53232,7 +53421,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.
operationId: public
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#public
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#public
parameters:
- name: User-Agent
in: header
@@ -53298,7 +53487,7 @@ x-webhooks:
description: A pull request was assigned to a user.
operationId: pull-request/assigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53348,7 +53537,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53365,7 +53554,7 @@ x-webhooks:
see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-disabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53415,7 +53604,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53432,7 +53621,7 @@ x-webhooks:
see "[Automatically merging a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-enabled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53482,7 +53671,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53500,7 +53689,7 @@ x-webhooks:
true in the webhook payload, the pull request was merged.
operationId: pull-request/closed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53550,7 +53739,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53567,7 +53756,7 @@ x-webhooks:
see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/converted-to-draft
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53617,7 +53806,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53633,7 +53822,7 @@ x-webhooks:
description: A pull request was removed from a milestone.
operationId: pull-request/demilestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53683,7 +53872,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53699,7 +53888,7 @@ x-webhooks:
description: A pull request was removed from the merge queue.
operationId: pull-request/dequeued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53749,7 +53938,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53765,7 +53954,7 @@ x-webhooks:
description: The title or body of a pull request was edited.
operationId: pull-request/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53815,7 +54004,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53831,7 +54020,7 @@ x-webhooks:
description: A pull request was added to the merge queue.
operationId: pull-request/enqueued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53881,7 +54070,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53897,7 +54086,7 @@ x-webhooks:
description: A label was added to a pull request.
operationId: pull-request/labeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -53947,7 +54136,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -53964,7 +54153,7 @@ x-webhooks:
see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/locked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54014,7 +54203,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54030,7 +54219,7 @@ x-webhooks:
description: A pull request was added to a milestone.
operationId: pull-request/milestoned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54080,7 +54269,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54096,7 +54285,7 @@ x-webhooks:
description: A pull request was created
operationId: pull-request/opened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54146,7 +54335,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54163,7 +54352,7 @@ x-webhooks:
see "[Changing the stage of a pull request](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/ready-for-review
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54213,7 +54402,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54229,7 +54418,7 @@ x-webhooks:
description: A previously closed pull request was reopened.
operationId: pull-request/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54279,7 +54468,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54295,7 +54484,7 @@ x-webhooks:
description: A comment on a pull request diff was created.
operationId: pull-request-review-comment/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54345,7 +54534,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54361,7 +54550,7 @@ x-webhooks:
description: A comment on a pull request diff was deleted.
operationId: pull-request-review-comment/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54411,7 +54600,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54427,7 +54616,7 @@ x-webhooks:
description: The content of a comment on a pull request diff was changed.
operationId: pull-request-review-comment/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-comment
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
@@ -54477,7 +54666,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-comment
+ subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
@@ -54493,7 +54682,7 @@ x-webhooks:
description: A review on a pull request was dismissed.
operationId: pull-request-review/dismissed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54543,7 +54732,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54559,7 +54748,7 @@ x-webhooks:
description: The body comment on a pull request review was edited.
operationId: pull-request-review/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54609,7 +54798,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54626,7 +54815,7 @@ x-webhooks:
request.
operationId: pull-request/review-request-removed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54676,7 +54865,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54693,7 +54882,7 @@ x-webhooks:
more information, see "[Requesting a pull request review](https://docs.github.com/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)."
operationId: pull-request/review-requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -54743,7 +54932,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -54759,7 +54948,7 @@ x-webhooks:
description: A review on a pull request was submitted.
operationId: pull-request-review/submitted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
@@ -54809,7 +54998,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review
+ subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
@@ -54825,7 +55014,7 @@ x-webhooks:
description: A comment thread on a pull request was marked as resolved.
operationId: pull-request-review-thread/resolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
@@ -54875,7 +55064,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-thread
+ subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
@@ -54892,7 +55081,7 @@ x-webhooks:
as unresolved.
operationId: pull-request-review-thread/unresolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request-review-thread
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
@@ -54942,7 +55131,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request-review-thread
+ subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
@@ -54960,7 +55149,7 @@ x-webhooks:
head branch.
operationId: pull-request/synchronize
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55010,7 +55199,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55026,7 +55215,7 @@ x-webhooks:
description: A user was unassigned from a pull request.
operationId: pull-request/unassigned
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55076,7 +55265,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55092,7 +55281,7 @@ x-webhooks:
description: A label was removed from a pull request.
operationId: pull-request/unlabeled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55142,7 +55331,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55159,7 +55348,7 @@ x-webhooks:
see "[Locking conversations](https://docs.github.com/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/unlocked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#pull-request
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
@@ -55209,7 +55398,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: pull-request
+ subcategory: pull_request
supported-webhook-types:
- repository
- organization
@@ -55217,14 +55406,16 @@ x-webhooks:
push:
post:
summary: |-
- This event occurs when a commit or tag is pushed, or when a repository is cloned.
+ This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
+ when a branch is deleted, when a tag is deleted, or when a repository is cloned. To subscribe to only branch
+ and tag deletions, use the [`delete`](#delete) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: An event will not be created when more than three tags are pushed at once.
operationId: push
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#push
parameters:
- name: User-Agent
in: header
@@ -55290,7 +55481,7 @@ x-webhooks:
description: A package was published to a registry.
operationId: registry-package/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#registry-package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
@@ -55340,7 +55531,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: registry-package
+ subcategory: registry_package
supported-webhook-types:
- repository
- organization
@@ -55356,7 +55547,7 @@ x-webhooks:
description: A package that was previously published to a registry was updated.
operationId: registry-package/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#registry-package
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
@@ -55406,7 +55597,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: registry-package
+ subcategory: registry_package
supported-webhook-types:
- repository
- organization
@@ -55421,7 +55612,7 @@ x-webhooks:
previously being saved as a draft.
operationId: release/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55485,7 +55676,7 @@ x-webhooks:
description: A release, pre-release, or draft release was deleted.
operationId: release/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55550,7 +55741,7 @@ x-webhooks:
For more information, see "[Managing releases in a repository](https://docs.github.com/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)."
operationId: release/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55615,7 +55806,7 @@ x-webhooks:
is a release that is not ready for production and may be unstable.
operationId: release/prereleased
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55679,7 +55870,7 @@ x-webhooks:
description: A release, pre-release, or draft of a release was published.
operationId: release/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55743,7 +55934,7 @@ x-webhooks:
description: A release was published, or a pre-release was changed to a release.
operationId: release/released
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55807,7 +55998,7 @@ x-webhooks:
description: A release or pre-release was unpublished.
operationId: release/unpublished
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#release
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
@@ -55871,7 +56062,7 @@ x-webhooks:
description: A repository security advisory was published.
operationId: repository-advisory/published
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory
parameters:
- name: User-Agent
in: header
@@ -55921,7 +56112,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-advisory
+ subcategory: repository_advisory
supported-webhook-types:
- repository
- organization
@@ -55935,7 +56126,7 @@ x-webhooks:
description: A private vulnerability report was submitted.
operationId: repository-advisory/reported
externalDocs:
- url: https://docs.github.com/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_advisory
parameters:
- name: User-Agent
in: header
@@ -55985,7 +56176,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-advisory
+ subcategory: repository_advisory
supported-webhook-types:
- repository
- organization
@@ -55999,7 +56190,7 @@ x-webhooks:
description: A repository was archived.
operationId: repository/archived
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56064,7 +56255,7 @@ x-webhooks:
description: A repository was created.
operationId: repository/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56130,7 +56321,7 @@ x-webhooks:
not receive this event.
operationId: repository/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56196,7 +56387,7 @@ x-webhooks:
request body.
operationId: repository-dispatch/sample.collected
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-dispatch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch
parameters:
- name: User-Agent
in: header
@@ -56246,7 +56437,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-dispatch
+ subcategory: repository_dispatch
supported-webhook-types:
- app
repository-edited:
@@ -56259,7 +56450,7 @@ x-webhooks:
was changed.
operationId: repository/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56322,7 +56513,7 @@ x-webhooks:
For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/rest/migrations/source-imports).
operationId: repository-import
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-import
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_import
parameters:
- name: User-Agent
in: header
@@ -56372,7 +56563,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-import
+ subcategory: repository_import
supported-webhook-types:
- repository
- organization
@@ -56385,7 +56576,7 @@ x-webhooks:
description: The visibility of a repository was changed to `private`.
operationId: repository/privatized
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56450,7 +56641,7 @@ x-webhooks:
description: The visibility of a repository was changed to `public`.
operationId: repository/publicized
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56515,7 +56706,7 @@ x-webhooks:
description: The name of a repository was changed.
operationId: repository/renamed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56582,7 +56773,7 @@ x-webhooks:
description: A repository ruleset was created.
operationId: repository-ruleset/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56632,7 +56823,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56648,7 +56839,7 @@ x-webhooks:
description: A repository ruleset was deleted.
operationId: repository-ruleset/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56698,7 +56889,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56714,7 +56905,7 @@ x-webhooks:
description: A repository ruleset was edited.
operationId: repository-ruleset/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-ruleset
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_ruleset
parameters:
- name: User-Agent
in: header
@@ -56764,7 +56955,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-ruleset
+ subcategory: repository_ruleset
supported-webhook-types:
- repository
- organization
@@ -56782,7 +56973,7 @@ x-webhooks:
events.
operationId: repository/transferred
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56847,7 +57038,7 @@ x-webhooks:
description: A previously archived repository was unarchived.
operationId: repository/unarchived
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
@@ -56912,7 +57103,7 @@ x-webhooks:
description: A repository vulnerability alert was created.
operationId: repository-vulnerability-alert/create
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -56962,7 +57153,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -56975,7 +57166,7 @@ x-webhooks:
description: A repository vulnerability alert was dismissed.
operationId: repository-vulnerability-alert/dismiss
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57025,7 +57216,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57039,7 +57230,7 @@ x-webhooks:
was reopened.
operationId: repository-vulnerability-alert/reopen
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57089,7 +57280,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57102,7 +57293,7 @@ x-webhooks:
description: A repository vulnerability alert was marked as resolved.
operationId: repository-vulnerability-alert/resolve
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#repository-vulnerability-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
@@ -57152,7 +57343,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: repository-vulnerability-alert
+ subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
@@ -57167,7 +57358,7 @@ x-webhooks:
description: A secret scanning alert was created.
operationId: secret-scanning-alert/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57217,7 +57408,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57236,7 +57427,7 @@ x-webhooks:
a repository, and the location of the secret was added to the existing alert.
operationId: secret-scanning-alert-location/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret_scanning_alert_location
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert_location
parameters:
- name: User-Agent
in: header
@@ -57312,7 +57503,7 @@ x-webhooks:
description: A previously closed secret scanning alert was reopened.
operationId: secret-scanning-alert/reopened
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57362,7 +57553,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57378,7 +57569,7 @@ x-webhooks:
description: A secret scanning alert was closed.
operationId: secret-scanning-alert/resolved
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57428,7 +57619,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57444,7 +57635,7 @@ x-webhooks:
description: A secret scanning alert was marked as revoked.
operationId: secret-scanning-alert/revoked
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#secret-scanning-alert
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
@@ -57494,7 +57685,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: secret-scanning-alert
+ subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
@@ -57508,7 +57699,7 @@ x-webhooks:
description: A security advisory was published to the GitHub community.
operationId: security-advisory/published
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57558,7 +57749,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-updated:
@@ -57571,7 +57762,7 @@ x-webhooks:
or the security advisory was withdrawn.
operationId: security-advisory/updated
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57621,7 +57812,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-withdrawn:
@@ -57633,7 +57824,7 @@ x-webhooks:
description: A previously published security advisory was withdrawn.
operationId: security-advisory/withdrawn
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-advisory
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
@@ -57683,7 +57874,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-advisory
+ subcategory: security_advisory
supported-webhook-types:
- app
security-and-analysis:
@@ -57694,7 +57885,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.
operationId: security-and-analysis
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#security-and-analysis
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis
parameters:
- name: User-Agent
in: header
@@ -57744,7 +57935,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: security-and-analysis
+ subcategory: security_and_analysis
supported-webhook-types:
- repository
- organization
@@ -57761,7 +57952,7 @@ x-webhooks:
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
operationId: sponsorship/cancelled
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -57824,7 +58015,7 @@ x-webhooks:
occurs once the payment is successfully processed.
operationId: sponsorship/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -57888,7 +58079,7 @@ x-webhooks:
to reflect the change when this event occurs.
operationId: sponsorship/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -57953,7 +58144,7 @@ x-webhooks:
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.
operationId: sponsorship/pending-cancellation
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58016,7 +58207,7 @@ x-webhooks:
new tier will become effective on their next billing date.
operationId: sponsorship/pending-tier-change
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58081,7 +58272,7 @@ x-webhooks:
the beginning of the sponsor's next billing cycle.
operationId: sponsorship/tier-changed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
@@ -58143,7 +58334,7 @@ x-webhooks:
description: Someone starred a repository.
operationId: star/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
@@ -58207,7 +58398,7 @@ x-webhooks:
description: Someone unstarred the repository.
operationId: star/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#star
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
@@ -58270,7 +58461,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.
operationId: status
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#status
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#status
parameters:
- name: User-Agent
in: header
@@ -58336,7 +58527,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.
operationId: team-add
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team-add
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add
parameters:
- name: User-Agent
in: header
@@ -58386,7 +58577,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: team-add
+ subcategory: team_add
supported-webhook-types:
- repository
- organization
@@ -58401,7 +58592,7 @@ x-webhooks:
description: A team was granted access to a repository.
operationId: team/added-to-repository
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58466,7 +58657,7 @@ x-webhooks:
description: A team was created.
operationId: team/created
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58531,7 +58722,7 @@ x-webhooks:
description: A team was deleted.
operationId: team/deleted
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58596,7 +58787,7 @@ x-webhooks:
description: The name, description, or visibility of a team was changed.
operationId: team/edited
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58661,7 +58852,7 @@ x-webhooks:
description: A team's access to a repository was removed.
operationId: team/removed-from-repository
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#team
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
@@ -58725,7 +58916,7 @@ x-webhooks:
description: Someone started watching the repository.
operationId: watch/started
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#watch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch
parameters:
- name: User-Agent
in: header
@@ -58790,7 +58981,7 @@ x-webhooks:
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
operationId: workflow-dispatch
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-dispatch
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch
parameters:
- name: User-Agent
in: header
@@ -58840,7 +59031,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-dispatch
+ subcategory: workflow_dispatch
supported-webhook-types:
- app
workflow-job-completed:
@@ -58856,7 +59047,7 @@ x-webhooks:
unsuccessful.
operationId: workflow-job/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -58906,7 +59097,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -58923,7 +59114,7 @@ x-webhooks:
description: A job in a workflow run started processing on a runner.
operationId: workflow-job/in-progress
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -58973,7 +59164,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -58990,7 +59181,7 @@ x-webhooks:
description: A job in a workflow run was created.
operationId: workflow-job/queued
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59040,7 +59231,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59057,7 +59248,7 @@ x-webhooks:
description: A job in a workflow run was created and is waiting for approvals.
operationId: workflow-job/waiting
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-job
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
@@ -59107,7 +59298,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-job
+ subcategory: workflow_job
supported-webhook-types:
- business
- repository
@@ -59125,7 +59316,7 @@ x-webhooks:
is completed, regardless of whether the workflow was successful or unsuccessful.
operationId: workflow-run/completed
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59175,7 +59366,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59192,7 +59383,7 @@ x-webhooks:
description: A workflow run started processing on a runner.
operationId: workflow-run/in-progress
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59242,7 +59433,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59259,7 +59450,7 @@ x-webhooks:
description: A workflow run was triggered.
operationId: workflow-run/requested
externalDocs:
- url: https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#workflow-run
+ url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
@@ -59309,7 +59500,7 @@ x-webhooks:
x-github:
githubCloudOnly: false
category: webhooks
- subcategory: workflow-run
+ subcategory: workflow_run
supported-webhook-types:
- business
- repository
@@ -59775,6 +59966,7 @@ components:
- name
credits:
type: array
+ description: The users who contributed to the advisory.
nullable: true
readOnly: true
items:
@@ -60665,7 +60857,7 @@ components:
access_tokens_url:
type: string
format: uri
- example: https://api.github.com/installations/1/access_tokens
+ example: https://api.github.com/app/installations/1/access_tokens
repositories_url:
type: string
format: uri
@@ -61036,6 +61228,7 @@ components:
default: true
type: boolean
example: true
+ deprecated: true
has_discussions:
description: Whether discussions are enabled.
default: false
@@ -61666,6 +61859,453 @@ components:
- created_at
- updated_at
- expires_at
+ simple-classroom-repository:
+ title: Simple Classroom Repository
+ description: A GitHub repository view for Classroom
+ type: object
+ properties:
+ id:
+ type: integer
+ example: 1296269
+ description: A unique identifier of the repository.
+ full_name:
+ type: string
+ example: octocat/Hello-World
+ description: The full, globally unique name of the repository.
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/octocat/Hello-World
+ description: The URL to view the repository on GitHub.com.
+ node_id:
+ type: string
+ example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ description: The GraphQL identifier of the repository.
+ private:
+ type: boolean
+ description: Whether the repository is private.
+ default_branch:
+ type: string
+ example: main
+ description: The default branch for the repository.
+ required:
+ - id
+ - full_name
+ - html_url
+ - node_id
+ - private
+ - default_branch
+ simple-classroom-organization:
+ title: Organization Simple for Classroom
+ description: A GitHub organization.
+ type: object
+ properties:
+ id:
+ type: integer
+ example: 1
+ login:
+ type: string
+ example: github
+ node_id:
+ type: string
+ example: MDEyOk9yZ2FuaXphdGlvbjE=
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/github
+ name:
+ type: string
+ example: Github - Code thigns happen here
+ nullable: true
+ avatar_url:
+ type: string
+ example: https://github.com/images/error/octocat_happy.gif
+ required:
+ - id
+ - login
+ - node_id
+ - html_url
+ - name
+ - avatar_url
+ classroom:
+ title: Classroom
+ description: A GitHub Classroom classroom
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the classroom.
+ example: 42
+ type: integer
+ name:
+ description: The name of the classroom.
+ type: string
+ example: Programming Elixir
+ archived:
+ description: Whether classroom is archived.
+ type: boolean
+ example: false
+ organization:
+ "$ref": "#/components/schemas/simple-classroom-organization"
+ url:
+ description: The URL of the classroom on GitHub Classroom.
+ type: string
+ example: https://classroom.github.com/classrooms/1-programming-elixir
+ required:
+ - id
+ - name
+ - archived
+ - organization
+ - url
+ classroom-assignment:
+ title: Classroom Assignment
+ description: A GitHub Classroom assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ example: 42
+ public_repo:
+ description: Whether an accepted assignment creates a public repository.
+ type: boolean
+ example: true
+ title:
+ description: Assignment title.
+ type: string
+ example: Intro to Binaries
+ type:
+ description: Whether it's a group assignment or individual assignment.
+ type: string
+ example: individual
+ enum:
+ - individual
+ - group
+ invite_link:
+ description: The link that a student can use to accept the assignment.
+ type: string
+ example: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled:
+ description: Whether the invitation link is enabled. Visiting an enabled
+ invitation link will accept the assignment.
+ type: boolean
+ example: true
+ slug:
+ description: Sluggified name of the assignment.
+ type: string
+ example: intro-to-binaries
+ students_are_repo_admins:
+ description: Whether students are admins on created repository when a student
+ accepts the assignment.
+ type: boolean
+ example: true
+ feedback_pull_requests_enabled:
+ description: Whether feedback pull request will be created when a student
+ accepts the assignment.
+ type: boolean
+ example: true
+ max_teams:
+ description: The maximum allowable teams for the assignment.
+ nullable: true
+ type: integer
+ example: 0
+ max_members:
+ description: The maximum allowable members per team.
+ nullable: true
+ type: integer
+ example: 0
+ editor:
+ description: The selected editor for the assignment.
+ type: string
+ example: codespaces
+ accepted:
+ description: The number of students that have accepted the assignment.
+ type: integer
+ example: 25
+ submitted:
+ description: The number of students that have submitted the assignment.
+ type: integer
+ example: 10
+ passing:
+ description: The number of students that have passed the assignment.
+ type: integer
+ example: 10
+ language:
+ description: The programming language used in the assignment.
+ type: string
+ example: elixir
+ deadline:
+ description: The time at which the assignment is due.
+ type: string
+ format: date-time
+ example: '2011-01-26T19:06:43Z'
+ nullable: true
+ starter_code_repository:
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ classroom:
+ "$ref": "#/components/schemas/classroom"
+ required:
+ - id
+ - public_repo
+ - title
+ - type
+ - invite_link
+ - invitations_enabled
+ - slug
+ - students_are_repo_admins
+ - feedback_pull_requests_enabled
+ - max_teams
+ - max_members
+ - editor
+ - accepted
+ - submitted
+ - passing
+ - language
+ - deadline
+ - starter_code_repository
+ - classroom
+ simple-classroom-user:
+ title: Simple Classroom User
+ description: A GitHub user simplified for Classroom.
+ type: object
+ properties:
+ id:
+ type: integer
+ example: 1
+ login:
+ type: string
+ example: octocat
+ avatar_url:
+ type: string
+ format: uri
+ example: https://github.com/images/error/octocat_happy.gif
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/octocat
+ required:
+ - id
+ - login
+ - avatar_url
+ - html_url
+ simple-classroom:
+ title: Simple Classroom
+ description: A GitHub Classroom classroom
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the classroom.
+ example: 42
+ type: integer
+ name:
+ description: The name of the classroom.
+ type: string
+ example: Programming Elixir
+ archived:
+ description: Returns whether classroom is archived or not.
+ type: boolean
+ example: false
+ url:
+ description: The url of the classroom on GitHub Classroom.
+ type: string
+ example: https://classroom.github.com/classrooms/1-programming-elixir
+ required:
+ - id
+ - name
+ - archived
+ - url
+ simple-classroom-assignment:
+ title: Simple Classroom Assignment
+ description: A GitHub Classroom assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ example: 42
+ public_repo:
+ description: Whether an accepted assignment creates a public repository.
+ type: boolean
+ example: true
+ title:
+ description: Assignment title.
+ type: string
+ example: Intro to Binaries
+ type:
+ description: Whether it's a Group Assignment or Individual Assignment.
+ type: string
+ example: individual
+ enum:
+ - individual
+ - group
+ invite_link:
+ description: The link that a student can use to accept the assignment.
+ type: string
+ example: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled:
+ description: Whether the invitation link is enabled. Visiting an enabled
+ invitation link will accept the assignment.
+ type: boolean
+ example: true
+ slug:
+ description: Sluggified name of the assignment.
+ type: string
+ example: intro-to-binaries
+ students_are_repo_admins:
+ description: Whether students are admins on created repository on accepted
+ assignment.
+ type: boolean
+ example: true
+ feedback_pull_requests_enabled:
+ description: Whether feedback pull request will be created on assignment
+ acceptance.
+ type: boolean
+ example: true
+ max_teams:
+ description: The maximum allowable teams for the assignment.
+ nullable: true
+ type: integer
+ example: 0
+ max_members:
+ description: The maximum allowable members per team.
+ nullable: true
+ type: integer
+ example: 0
+ editor:
+ description: The selected editor for the assignment.
+ type: string
+ example: codespaces
+ accepted:
+ description: The number of students that have accepted the assignment.
+ type: integer
+ example: 25
+ submitted:
+ description: The number of students that have submitted the assignment.
+ type: integer
+ example: 10
+ passing:
+ description: The number of students that have passed the assignment.
+ type: integer
+ example: 10
+ language:
+ description: The programming language used in the assignment.
+ type: string
+ example: elixir
+ deadline:
+ description: The time at which the assignment is due.
+ type: string
+ format: date-time
+ example: '2011-01-26T19:06:43Z'
+ nullable: true
+ classroom:
+ "$ref": "#/components/schemas/simple-classroom"
+ required:
+ - id
+ - public_repo
+ - title
+ - type
+ - invite_link
+ - invitations_enabled
+ - slug
+ - students_are_repo_admins
+ - feedback_pull_requests_enabled
+ - editor
+ - accepted
+ - submitted
+ - passing
+ - language
+ - deadline
+ - classroom
+ classroom-accepted-assignment:
+ title: Classroom Accepted Assignment
+ description: A GitHub Classroom accepted assignment
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository.
+ type: integer
+ example: 42
+ submitted:
+ description: Whether an accepted assignment has been submitted.
+ type: boolean
+ example: true
+ passing:
+ description: Whether a submission passed.
+ type: boolean
+ example: true
+ commit_count:
+ description: Count of student commits.
+ type: integer
+ example: 5
+ grade:
+ description: Most recent grade.
+ type: string
+ example: 10/10
+ students:
+ type: array
+ items:
+ "$ref": "#/components/schemas/simple-classroom-user"
+ repository:
+ "$ref": "#/components/schemas/simple-classroom-repository"
+ assignment:
+ "$ref": "#/components/schemas/simple-classroom-assignment"
+ required:
+ - id
+ - submitted
+ - passing
+ - commit_count
+ - grade
+ - students
+ - repository
+ - assignment
+ classroom-assignment-grade:
+ title: Classroom Assignment Grade
+ description: Grade for a student or groups GitHub Classroom assignment
+ type: object
+ properties:
+ assignment_name:
+ description: Name of the assignment
+ type: string
+ assignment_url:
+ description: URL of the assignment
+ type: string
+ starter_code_url:
+ description: URL of the starter code for the assignment
+ type: string
+ github_username:
+ description: GitHub username of the student
+ type: string
+ roster_identifier:
+ description: Roster identifier of the student
+ type: string
+ student_repository_name:
+ description: Name of the student's assignment repository
+ type: string
+ student_repository_url:
+ description: URL of the student's assignment repository
+ type: string
+ submission_timestamp:
+ description: Timestamp of the student's assignment submission
+ type: string
+ points_awarded:
+ description: Number of points awarded to the student
+ type: integer
+ points_available:
+ description: Number of points available for the assignment
+ type: integer
+ group_name:
+ description: If a group assignment, name of the group the student is in
+ type: string
+ required:
+ - assignment_name
+ - assignment_url
+ - starter_code_url
+ - github_username
+ - roster_identifier
+ - student_repository_name
+ - student_repository_url
+ - submission_timestamp
+ - points_awarded
+ - points_available
code-of-conduct:
title: Code Of Conduct
description: Code Of Conduct
@@ -69025,6 +69665,7 @@ components:
default: true
type: boolean
example: true
+ deprecated: true
has_discussions:
description: Whether discussions are enabled.
default: false
@@ -75409,8 +76050,6 @@ components:
- versionInfo
- downloadLocation
- filesAnalyzed
- - licenseConcluded
- - licenseDeclared
- supplier
required:
- SPDXID
@@ -82884,8 +83523,10 @@ components:
- id
simple-installation:
title: Simple Installation
- description: The GitHub App installation. This property is included when the
- event is configured for and sent to a GitHub App.
+ description: |-
+ The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured
+ for and sent to a GitHub App. For more information,
+ see "[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)."
type: object
properties:
id:
@@ -82899,6 +83540,903 @@ components:
required:
- id
- node_id
+ organization-simple-webhooks:
+ title: Organization Simple
+ description: |-
+ A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an
+ organization, or when the event occurs from activity in a repository owned by an organization.
+ type: object
+ properties:
+ login:
+ type: string
+ example: github
+ id:
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDEyOk9yZ2FuaXphdGlvbjE=
+ url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github
+ repos_url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github/repos
+ events_url:
+ type: string
+ format: uri
+ example: https://api.github.com/orgs/github/events
+ hooks_url:
+ type: string
+ example: https://api.github.com/orgs/github/hooks
+ issues_url:
+ type: string
+ example: https://api.github.com/orgs/github/issues
+ members_url:
+ type: string
+ example: https://api.github.com/orgs/github/members{/member}
+ public_members_url:
+ type: string
+ example: https://api.github.com/orgs/github/public_members{/member}
+ avatar_url:
+ type: string
+ example: https://github.com/images/error/octocat_happy.gif
+ description:
+ type: string
+ example: A great organization
+ nullable: true
+ required:
+ - login
+ - url
+ - id
+ - node_id
+ - repos_url
+ - events_url
+ - hooks_url
+ - issues_url
+ - members_url
+ - public_members_url
+ - avatar_url
+ - description
+ repository-webhooks:
+ title: Repository
+ description: |-
+ The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ when the event occurs from activity in a repository.
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository
+ example: 42
+ type: integer
+ node_id:
+ type: string
+ example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ name:
+ description: The name of the repository.
+ type: string
+ example: Team Environment
+ full_name:
+ type: string
+ example: octocat/Hello-World
+ license:
+ "$ref": "#/components/schemas/nullable-license-simple"
+ organization:
+ "$ref": "#/components/schemas/nullable-simple-user"
+ forks:
+ type: integer
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ required:
+ - admin
+ - pull
+ - push
+ owner:
+ "$ref": "#/components/schemas/simple-user"
+ private:
+ description: Whether the repository is private or public.
+ default: false
+ type: boolean
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/octocat/Hello-World
+ description:
+ type: string
+ example: This your first repo!
+ nullable: true
+ fork:
+ type: boolean
+ url:
+ type: string
+ format: uri
+ example: https://api.github.com/repos/octocat/Hello-World
+ archive_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
+ assignees_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
+ blobs_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
+ branches_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
+ collaborators_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
+ comments_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
+ commits_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
+ compare_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
+ contents_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
+ contributors_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/contributors
+ deployments_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/deployments
+ downloads_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/downloads
+ events_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/events
+ forks_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/forks
+ git_commits_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
+ git_refs_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
+ git_tags_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
+ git_url:
+ type: string
+ example: git:github.com/octocat/Hello-World.git
+ issue_comment_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
+ issue_events_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
+ issues_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
+ keys_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
+ labels_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
+ languages_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/languages
+ merges_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/merges
+ milestones_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
+ notifications_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
+ pulls_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
+ releases_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
+ ssh_url:
+ type: string
+ example: git@github.com:octocat/Hello-World.git
+ stargazers_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/stargazers
+ statuses_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
+ subscribers_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/subscribers
+ subscription_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/subscription
+ tags_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/tags
+ teams_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/teams
+ trees_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
+ clone_url:
+ type: string
+ example: https://github.com/octocat/Hello-World.git
+ mirror_url:
+ type: string
+ format: uri
+ example: git:git.example.com/octocat/Hello-World
+ nullable: true
+ hooks_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/hooks
+ svn_url:
+ type: string
+ format: uri
+ example: https://svn.github.com/octocat/Hello-World
+ homepage:
+ type: string
+ format: uri
+ example: https://github.com
+ nullable: true
+ language:
+ type: string
+ nullable: true
+ forks_count:
+ type: integer
+ example: 9
+ stargazers_count:
+ type: integer
+ example: 80
+ watchers_count:
+ type: integer
+ example: 80
+ size:
+ description: The size of the repository. Size is calculated hourly. When
+ a repository is initially created, the size is 0.
+ type: integer
+ example: 108
+ default_branch:
+ description: The default branch of the repository.
+ type: string
+ example: master
+ open_issues_count:
+ type: integer
+ example: 0
+ is_template:
+ description: Whether this repository acts as a template that can be used
+ to generate new repositories.
+ default: false
+ type: boolean
+ example: true
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ description: Whether issues are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_projects:
+ description: Whether projects are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_wiki:
+ description: Whether the wiki is enabled.
+ default: true
+ type: boolean
+ example: true
+ has_pages:
+ type: boolean
+ has_downloads:
+ description: Whether downloads are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_discussions:
+ description: Whether discussions are enabled.
+ default: false
+ type: boolean
+ example: true
+ archived:
+ description: Whether the repository is archived.
+ default: false
+ type: boolean
+ disabled:
+ type: boolean
+ description: Returns whether or not this repository disabled.
+ visibility:
+ description: 'The repository visibility: public, private, or internal.'
+ default: public
+ type: string
+ pushed_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:06:43Z'
+ nullable: true
+ created_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:01:12Z'
+ nullable: true
+ updated_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:14:43Z'
+ nullable: true
+ allow_rebase_merge:
+ description: Whether to allow rebase merges for pull requests.
+ default: true
+ type: boolean
+ example: true
+ template_repository:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ full_name:
+ type: string
+ owner:
+ type: object
+ properties:
+ login:
+ type: string
+ id:
+ type: integer
+ node_id:
+ type: string
+ avatar_url:
+ type: string
+ gravatar_id:
+ type: string
+ url:
+ type: string
+ html_url:
+ type: string
+ followers_url:
+ type: string
+ following_url:
+ type: string
+ gists_url:
+ type: string
+ starred_url:
+ type: string
+ subscriptions_url:
+ type: string
+ organizations_url:
+ type: string
+ repos_url:
+ type: string
+ events_url:
+ type: string
+ received_events_url:
+ type: string
+ type:
+ type: string
+ site_admin:
+ type: boolean
+ private:
+ type: boolean
+ html_url:
+ type: string
+ description:
+ type: string
+ fork:
+ type: boolean
+ url:
+ type: string
+ archive_url:
+ type: string
+ assignees_url:
+ type: string
+ blobs_url:
+ type: string
+ branches_url:
+ type: string
+ collaborators_url:
+ type: string
+ comments_url:
+ type: string
+ commits_url:
+ type: string
+ compare_url:
+ type: string
+ contents_url:
+ type: string
+ contributors_url:
+ type: string
+ deployments_url:
+ type: string
+ downloads_url:
+ type: string
+ events_url:
+ type: string
+ forks_url:
+ type: string
+ git_commits_url:
+ type: string
+ git_refs_url:
+ type: string
+ git_tags_url:
+ type: string
+ git_url:
+ type: string
+ issue_comment_url:
+ type: string
+ issue_events_url:
+ type: string
+ issues_url:
+ type: string
+ keys_url:
+ type: string
+ labels_url:
+ type: string
+ languages_url:
+ type: string
+ merges_url:
+ type: string
+ milestones_url:
+ type: string
+ notifications_url:
+ type: string
+ pulls_url:
+ type: string
+ releases_url:
+ type: string
+ ssh_url:
+ type: string
+ stargazers_url:
+ type: string
+ statuses_url:
+ type: string
+ subscribers_url:
+ type: string
+ subscription_url:
+ type: string
+ tags_url:
+ type: string
+ teams_url:
+ type: string
+ trees_url:
+ type: string
+ clone_url:
+ type: string
+ mirror_url:
+ type: string
+ hooks_url:
+ type: string
+ svn_url:
+ type: string
+ homepage:
+ type: string
+ language:
+ type: string
+ forks_count:
+ type: integer
+ stargazers_count:
+ type: integer
+ watchers_count:
+ type: integer
+ size:
+ type: integer
+ default_branch:
+ type: string
+ open_issues_count:
+ type: integer
+ is_template:
+ type: boolean
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ type: boolean
+ has_projects:
+ type: boolean
+ has_wiki:
+ type: boolean
+ has_pages:
+ type: boolean
+ has_downloads:
+ type: boolean
+ archived:
+ type: boolean
+ disabled:
+ type: boolean
+ visibility:
+ type: string
+ pushed_at:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ maintain:
+ type: boolean
+ push:
+ type: boolean
+ triage:
+ type: boolean
+ pull:
+ type: boolean
+ allow_rebase_merge:
+ type: boolean
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ type: boolean
+ allow_auto_merge:
+ type: boolean
+ delete_branch_on_merge:
+ type: boolean
+ allow_update_branch:
+ type: boolean
+ use_squash_pr_title_as_default:
+ type: boolean
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ description: Whether to allow squash merges for pull requests.
+ default: true
+ type: boolean
+ example: true
+ allow_auto_merge:
+ description: Whether to allow Auto-merge to be used on pull requests.
+ default: false
+ type: boolean
+ example: false
+ delete_branch_on_merge:
+ description: Whether to delete head branches when pull requests are merged
+ default: false
+ type: boolean
+ example: false
+ 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
+ example: false
+ use_squash_pr_title_as_default:
+ type: boolean
+ 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
+ deprecated: true
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ description: Whether to allow merge commits for pull requests.
+ default: true
+ type: boolean
+ example: true
+ allow_forking:
+ description: Whether to allow forking this repo
+ type: boolean
+ web_commit_signoff_required:
+ description: Whether to require contributors to sign off on web-based commits
+ default: false
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ open_issues:
+ type: integer
+ watchers:
+ type: integer
+ master_branch:
+ type: string
+ starred_at:
+ type: string
+ example: '"2020-07-09T00:17:42Z"'
+ anonymous_access_enabled:
+ type: boolean
+ description: Whether anonymous git access is enabled for this repository
+ required:
+ - archive_url
+ - assignees_url
+ - blobs_url
+ - branches_url
+ - collaborators_url
+ - comments_url
+ - commits_url
+ - compare_url
+ - contents_url
+ - contributors_url
+ - deployments_url
+ - description
+ - downloads_url
+ - events_url
+ - fork
+ - forks_url
+ - full_name
+ - git_commits_url
+ - git_refs_url
+ - git_tags_url
+ - hooks_url
+ - html_url
+ - id
+ - node_id
+ - issue_comment_url
+ - issue_events_url
+ - issues_url
+ - keys_url
+ - labels_url
+ - languages_url
+ - merges_url
+ - milestones_url
+ - name
+ - notifications_url
+ - owner
+ - private
+ - pulls_url
+ - releases_url
+ - stargazers_url
+ - statuses_url
+ - subscribers_url
+ - subscription_url
+ - tags_url
+ - teams_url
+ - trees_url
+ - url
+ - clone_url
+ - default_branch
+ - forks
+ - forks_count
+ - git_url
+ - has_downloads
+ - has_issues
+ - has_projects
+ - has_wiki
+ - has_pages
+ - homepage
+ - language
+ - archived
+ - disabled
+ - mirror_url
+ - open_issues
+ - open_issues_count
+ - license
+ - pushed_at
+ - size
+ - ssh_url
+ - stargazers_count
+ - svn_url
+ - watchers
+ - watchers_count
+ - created_at
+ - updated_at
+ simple-user-webhooks:
+ title: Simple User
+ description: The GitHub user that triggered the event. This property is included
+ in every webhook payload.
+ type: object
+ properties:
+ name:
+ nullable: true
+ type: string
+ email:
+ nullable: true
+ type: string
+ login:
+ type: string
+ example: octocat
+ id:
+ type: integer
+ example: 1
+ node_id:
+ type: string
+ example: MDQ6VXNlcjE=
+ avatar_url:
+ type: string
+ format: uri
+ example: https://github.com/images/error/octocat_happy.gif
+ gravatar_id:
+ type: string
+ example: 41d064eb2195891e12d0413f63227ea7
+ nullable: true
+ url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/octocat
+ followers_url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat/followers
+ following_url:
+ type: string
+ example: https://api.github.com/users/octocat/following{/other_user}
+ gists_url:
+ type: string
+ example: https://api.github.com/users/octocat/gists{/gist_id}
+ starred_url:
+ type: string
+ example: https://api.github.com/users/octocat/starred{/owner}{/repo}
+ subscriptions_url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat/subscriptions
+ organizations_url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat/orgs
+ repos_url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat/repos
+ events_url:
+ type: string
+ example: https://api.github.com/users/octocat/events{/privacy}
+ received_events_url:
+ type: string
+ format: uri
+ example: https://api.github.com/users/octocat/received_events
+ type:
+ type: string
+ example: User
+ site_admin:
+ type: boolean
+ starred_at:
+ type: string
+ example: '"2020-07-09T00:17:55Z"'
+ required:
+ - avatar_url
+ - events_url
+ - followers_url
+ - following_url
+ - gists_url
+ - gravatar_id
+ - html_url
+ - id
+ - node_id
+ - login
+ - organizations_url
+ - received_events_url
+ - repos_url
+ - site_admin
+ - starred_url
+ - subscriptions_url
+ - type
+ - url
simple-check-suite:
description: A suite of checks performed on the code of a given code change
type: object
@@ -83409,6 +84947,748 @@ components:
- base_sha
- base_ref
- head_commit
+ nullable-repository-webhooks:
+ title: Repository
+ description: |-
+ The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property
+ when the event occurs from activity in a repository.
+ type: object
+ properties:
+ id:
+ description: Unique identifier of the repository
+ example: 42
+ type: integer
+ node_id:
+ type: string
+ example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ name:
+ description: The name of the repository.
+ type: string
+ example: Team Environment
+ full_name:
+ type: string
+ example: octocat/Hello-World
+ license:
+ "$ref": "#/components/schemas/nullable-license-simple"
+ organization:
+ "$ref": "#/components/schemas/nullable-simple-user"
+ forks:
+ type: integer
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ pull:
+ type: boolean
+ triage:
+ type: boolean
+ push:
+ type: boolean
+ maintain:
+ type: boolean
+ required:
+ - admin
+ - pull
+ - push
+ owner:
+ "$ref": "#/components/schemas/simple-user"
+ private:
+ description: Whether the repository is private or public.
+ default: false
+ type: boolean
+ html_url:
+ type: string
+ format: uri
+ example: https://github.com/octocat/Hello-World
+ description:
+ type: string
+ example: This your first repo!
+ nullable: true
+ fork:
+ type: boolean
+ url:
+ type: string
+ format: uri
+ example: https://api.github.com/repos/octocat/Hello-World
+ archive_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
+ assignees_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
+ blobs_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
+ branches_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
+ collaborators_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
+ comments_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
+ commits_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
+ compare_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
+ contents_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
+ contributors_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/contributors
+ deployments_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/deployments
+ downloads_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/downloads
+ events_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/events
+ forks_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/forks
+ git_commits_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
+ git_refs_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
+ git_tags_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
+ git_url:
+ type: string
+ example: git:github.com/octocat/Hello-World.git
+ issue_comment_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
+ issue_events_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
+ issues_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
+ keys_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
+ labels_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
+ languages_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/languages
+ merges_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/merges
+ milestones_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
+ notifications_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
+ pulls_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
+ releases_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
+ ssh_url:
+ type: string
+ example: git@github.com:octocat/Hello-World.git
+ stargazers_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/stargazers
+ statuses_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
+ subscribers_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/subscribers
+ subscription_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/subscription
+ tags_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/tags
+ teams_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/teams
+ trees_url:
+ type: string
+ example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
+ clone_url:
+ type: string
+ example: https://github.com/octocat/Hello-World.git
+ mirror_url:
+ type: string
+ format: uri
+ example: git:git.example.com/octocat/Hello-World
+ nullable: true
+ hooks_url:
+ type: string
+ format: uri
+ example: http://api.github.com/repos/octocat/Hello-World/hooks
+ svn_url:
+ type: string
+ format: uri
+ example: https://svn.github.com/octocat/Hello-World
+ homepage:
+ type: string
+ format: uri
+ example: https://github.com
+ nullable: true
+ language:
+ type: string
+ nullable: true
+ forks_count:
+ type: integer
+ example: 9
+ stargazers_count:
+ type: integer
+ example: 80
+ watchers_count:
+ type: integer
+ example: 80
+ size:
+ description: The size of the repository. Size is calculated hourly. When
+ a repository is initially created, the size is 0.
+ type: integer
+ example: 108
+ default_branch:
+ description: The default branch of the repository.
+ type: string
+ example: master
+ open_issues_count:
+ type: integer
+ example: 0
+ is_template:
+ description: Whether this repository acts as a template that can be used
+ to generate new repositories.
+ default: false
+ type: boolean
+ example: true
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ description: Whether issues are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_projects:
+ description: Whether projects are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_wiki:
+ description: Whether the wiki is enabled.
+ default: true
+ type: boolean
+ example: true
+ has_pages:
+ type: boolean
+ has_downloads:
+ description: Whether downloads are enabled.
+ default: true
+ type: boolean
+ example: true
+ has_discussions:
+ description: Whether discussions are enabled.
+ default: false
+ type: boolean
+ example: true
+ archived:
+ description: Whether the repository is archived.
+ default: false
+ type: boolean
+ disabled:
+ type: boolean
+ description: Returns whether or not this repository disabled.
+ visibility:
+ description: 'The repository visibility: public, private, or internal.'
+ default: public
+ type: string
+ pushed_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:06:43Z'
+ nullable: true
+ created_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:01:12Z'
+ nullable: true
+ updated_at:
+ type: string
+ format: date-time
+ example: '2011-01-26T19:14:43Z'
+ nullable: true
+ allow_rebase_merge:
+ description: Whether to allow rebase merges for pull requests.
+ default: true
+ type: boolean
+ example: true
+ template_repository:
+ nullable: true
+ type: object
+ properties:
+ id:
+ type: integer
+ node_id:
+ type: string
+ name:
+ type: string
+ full_name:
+ type: string
+ owner:
+ type: object
+ properties:
+ login:
+ type: string
+ id:
+ type: integer
+ node_id:
+ type: string
+ avatar_url:
+ type: string
+ gravatar_id:
+ type: string
+ url:
+ type: string
+ html_url:
+ type: string
+ followers_url:
+ type: string
+ following_url:
+ type: string
+ gists_url:
+ type: string
+ starred_url:
+ type: string
+ subscriptions_url:
+ type: string
+ organizations_url:
+ type: string
+ repos_url:
+ type: string
+ events_url:
+ type: string
+ received_events_url:
+ type: string
+ type:
+ type: string
+ site_admin:
+ type: boolean
+ private:
+ type: boolean
+ html_url:
+ type: string
+ description:
+ type: string
+ fork:
+ type: boolean
+ url:
+ type: string
+ archive_url:
+ type: string
+ assignees_url:
+ type: string
+ blobs_url:
+ type: string
+ branches_url:
+ type: string
+ collaborators_url:
+ type: string
+ comments_url:
+ type: string
+ commits_url:
+ type: string
+ compare_url:
+ type: string
+ contents_url:
+ type: string
+ contributors_url:
+ type: string
+ deployments_url:
+ type: string
+ downloads_url:
+ type: string
+ events_url:
+ type: string
+ forks_url:
+ type: string
+ git_commits_url:
+ type: string
+ git_refs_url:
+ type: string
+ git_tags_url:
+ type: string
+ git_url:
+ type: string
+ issue_comment_url:
+ type: string
+ issue_events_url:
+ type: string
+ issues_url:
+ type: string
+ keys_url:
+ type: string
+ labels_url:
+ type: string
+ languages_url:
+ type: string
+ merges_url:
+ type: string
+ milestones_url:
+ type: string
+ notifications_url:
+ type: string
+ pulls_url:
+ type: string
+ releases_url:
+ type: string
+ ssh_url:
+ type: string
+ stargazers_url:
+ type: string
+ statuses_url:
+ type: string
+ subscribers_url:
+ type: string
+ subscription_url:
+ type: string
+ tags_url:
+ type: string
+ teams_url:
+ type: string
+ trees_url:
+ type: string
+ clone_url:
+ type: string
+ mirror_url:
+ type: string
+ hooks_url:
+ type: string
+ svn_url:
+ type: string
+ homepage:
+ type: string
+ language:
+ type: string
+ forks_count:
+ type: integer
+ stargazers_count:
+ type: integer
+ watchers_count:
+ type: integer
+ size:
+ type: integer
+ default_branch:
+ type: string
+ open_issues_count:
+ type: integer
+ is_template:
+ type: boolean
+ topics:
+ type: array
+ items:
+ type: string
+ has_issues:
+ type: boolean
+ has_projects:
+ type: boolean
+ has_wiki:
+ type: boolean
+ has_pages:
+ type: boolean
+ has_downloads:
+ type: boolean
+ archived:
+ type: boolean
+ disabled:
+ type: boolean
+ visibility:
+ type: string
+ pushed_at:
+ type: string
+ created_at:
+ type: string
+ updated_at:
+ type: string
+ permissions:
+ type: object
+ properties:
+ admin:
+ type: boolean
+ maintain:
+ type: boolean
+ push:
+ type: boolean
+ triage:
+ type: boolean
+ pull:
+ type: boolean
+ allow_rebase_merge:
+ type: boolean
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ type: boolean
+ allow_auto_merge:
+ type: boolean
+ delete_branch_on_merge:
+ type: boolean
+ allow_update_branch:
+ type: boolean
+ use_squash_pr_title_as_default:
+ type: boolean
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ temp_clone_token:
+ type: string
+ allow_squash_merge:
+ description: Whether to allow squash merges for pull requests.
+ default: true
+ type: boolean
+ example: true
+ allow_auto_merge:
+ description: Whether to allow Auto-merge to be used on pull requests.
+ default: false
+ type: boolean
+ example: false
+ delete_branch_on_merge:
+ description: Whether to delete head branches when pull requests are merged
+ default: false
+ type: boolean
+ example: false
+ 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
+ example: false
+ use_squash_pr_title_as_default:
+ type: boolean
+ 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
+ deprecated: true
+ squash_merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - COMMIT_OR_PR_TITLE
+ description: |-
+ The default value for a squash merge commit title:
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `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).
+ squash_merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - COMMIT_MESSAGES
+ - BLANK
+ description: |-
+ The default value for a squash merge commit message:
+
+ - `PR_BODY` - default to the pull request's body.
+ - `COMMIT_MESSAGES` - default to the branch's commit messages.
+ - `BLANK` - default to a blank commit message.
+ merge_commit_title:
+ type: string
+ enum:
+ - PR_TITLE
+ - MERGE_MESSAGE
+ description: |-
+ The default value for a merge commit title.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
+ merge_commit_message:
+ type: string
+ enum:
+ - PR_BODY
+ - PR_TITLE
+ - BLANK
+ description: |-
+ The default value for a merge commit message.
+
+ - `PR_TITLE` - default to the pull request's title.
+ - `PR_BODY` - default to the pull request's body.
+ - `BLANK` - default to a blank commit message.
+ allow_merge_commit:
+ description: Whether to allow merge commits for pull requests.
+ default: true
+ type: boolean
+ example: true
+ allow_forking:
+ description: Whether to allow forking this repo
+ type: boolean
+ web_commit_signoff_required:
+ description: Whether to require contributors to sign off on web-based commits
+ default: false
+ type: boolean
+ subscribers_count:
+ type: integer
+ network_count:
+ type: integer
+ open_issues:
+ type: integer
+ watchers:
+ type: integer
+ master_branch:
+ type: string
+ starred_at:
+ type: string
+ example: '"2020-07-09T00:17:42Z"'
+ anonymous_access_enabled:
+ type: boolean
+ description: Whether anonymous git access is enabled for this repository
+ required:
+ - archive_url
+ - assignees_url
+ - blobs_url
+ - branches_url
+ - collaborators_url
+ - comments_url
+ - commits_url
+ - compare_url
+ - contents_url
+ - contributors_url
+ - deployments_url
+ - description
+ - downloads_url
+ - events_url
+ - fork
+ - forks_url
+ - full_name
+ - git_commits_url
+ - git_refs_url
+ - git_tags_url
+ - hooks_url
+ - html_url
+ - id
+ - node_id
+ - issue_comment_url
+ - issue_events_url
+ - issues_url
+ - keys_url
+ - labels_url
+ - languages_url
+ - merges_url
+ - milestones_url
+ - name
+ - notifications_url
+ - owner
+ - private
+ - pulls_url
+ - releases_url
+ - stargazers_url
+ - statuses_url
+ - subscribers_url
+ - subscription_url
+ - tags_url
+ - teams_url
+ - trees_url
+ - url
+ - clone_url
+ - default_branch
+ - forks
+ - forks_count
+ - git_url
+ - has_downloads
+ - has_issues
+ - has_projects
+ - has_wiki
+ - has_pages
+ - homepage
+ - language
+ - archived
+ - disabled
+ - mirror_url
+ - open_issues
+ - open_issues_count
+ - license
+ - pushed_at
+ - size
+ - ssh_url
+ - stargazers_count
+ - svn_url
+ - watchers
+ - watchers_count
+ - created_at
+ - updated_at
+ nullable: true
personal-access-token-request:
title: Personal Access Token Request
description: Details of a Personal Access Token Request.
@@ -83714,11 +85994,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -83736,11 +86016,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -83758,9 +86038,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -83892,7 +86172,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -83911,9 +86191,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -84045,7 +86325,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -84132,9 +86412,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
rule:
title: branch protection rule
description: The branch protection rule. Includes a `name` and all the [branch
@@ -84266,7 +86546,7 @@ components:
- authorized_actors_only
- authorized_actor_names
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- rule
@@ -84285,11 +86565,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -84318,11 +86598,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -84351,9 +86631,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_action:
description: The action requested by the user.
type: object
@@ -84363,7 +86643,7 @@ components:
user.
type: string
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_run
@@ -84393,11 +86673,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- check_run
- repository
@@ -85002,11 +87282,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -85600,11 +87880,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -86192,11 +88472,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- check_suite
@@ -86438,16 +88718,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -86709,16 +88989,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -86919,16 +89199,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87193,16 +89473,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87398,7 +89678,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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
@@ -87406,9 +89686,9 @@ components:
type: string
nullable: true
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87578,16 +89858,16 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
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.
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87779,11 +90059,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -87805,7 +90085,7 @@ components:
description: The name of the repository's default branch (usually `main`).
type: string
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher_type:
description: The pusher type for the event. Can be either `user` or a deploy
key.
@@ -87821,9 +90101,9 @@ components:
- tag
- branch
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- ref_type
@@ -87841,7 +90121,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher_type:
description: The pusher type for the event. Can be either `user` or a deploy
key.
@@ -87857,9 +90137,9 @@ components:
- tag
- branch
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- ref_type
@@ -87879,13 +90159,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87904,13 +90184,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87929,13 +90209,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87954,13 +90234,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -87979,13 +90259,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88004,13 +90284,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88029,13 +90309,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
enterprise:
"$ref": "#/components/schemas/enterprise"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -88088,11 +90368,11 @@ components:
- created_at
- read_only
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- key
@@ -88145,11 +90425,11 @@ components:
- created_at
- read_only
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- key
@@ -88645,11 +90925,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type: object
@@ -89316,13 +91596,13 @@ components:
items:
"$ref": "#/components/schemas/pull-request"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
webhook-deployment-review-approved:
type: object
properties:
@@ -89376,9 +91656,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
reviewers:
type: array
items:
@@ -89456,7 +91736,7 @@ components:
enum:
- User
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -90166,9 +92446,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
reviewers:
type: array
items:
@@ -90246,7 +92526,7 @@ components:
enum:
- User
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -90917,9 +93197,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requestor:
title: User
type: object
@@ -91064,7 +93344,7 @@ components:
- User
- Team
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
since:
type: string
workflow_job_run:
@@ -92737,11 +95017,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type: object
@@ -93552,11 +95832,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -93622,11 +95902,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -93648,11 +95928,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -93827,11 +96107,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -94007,11 +96287,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -94199,11 +96479,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -94646,11 +96926,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94671,11 +96951,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94713,11 +96993,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94770,11 +97050,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94796,11 +97076,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94821,11 +97101,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94846,11 +97126,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -94870,7 +97150,7 @@ components:
new_discussion:
"$ref": "#/components/schemas/discussion"
new_repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
required:
- new_discussion
- new_repository
@@ -94881,11 +97161,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -95057,11 +97337,11 @@ components:
- updated_at
- body
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95114,11 +97394,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95140,11 +97420,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95165,11 +97445,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- discussion
@@ -95841,11 +98121,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- forkee
- repository
@@ -95863,11 +98143,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- sender
@@ -95880,7 +98160,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pages:
description: The pages that were updated.
type: array
@@ -95918,9 +98198,9 @@ components:
- sha
- html_url
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- pages
- repository
@@ -95938,7 +98218,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -95965,7 +98245,7 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
title: User
type: object
@@ -96034,7 +98314,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96052,7 +98332,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -96079,11 +98359,11 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
nullable: true
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96101,7 +98381,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -96128,11 +98408,11 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
nullable: true
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96150,7 +98430,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories_added:
description: An array of repository objects, which were added to the installation.
type: array
@@ -96197,7 +98477,7 @@ components:
description: Whether the repository is private or public.
type: boolean
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_selection:
description: Describe whether all repositories have been selected or there's
a selection involved
@@ -96273,7 +98553,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96295,7 +98575,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories_added:
description: An array of repository objects, which were added to the installation.
type: array
@@ -96348,7 +98628,7 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_selection:
description: Describe whether all repositories have been selected or there's
a selection involved
@@ -96424,7 +98704,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96446,7 +98726,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -96473,11 +98753,11 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
nullable: true
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -96592,11 +98872,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
target_type:
type: string
required:
@@ -96618,7 +98898,7 @@ components:
installation:
"$ref": "#/components/schemas/installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repositories:
description: An array of repository objects that the installation can access.
type: array
@@ -96645,11 +98925,11 @@ components:
- full_name
- private
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requester:
nullable: true
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- installation
@@ -97955,11 +100235,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -99264,11 +101544,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -100588,11 +102868,11 @@ components:
- locked
- assignee
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -101573,11 +103853,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -102626,11 +104906,11 @@ components:
- state
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -103535,11 +105815,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -104848,11 +107128,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -105816,11 +108096,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -106764,11 +109044,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -107813,11 +110093,11 @@ components:
- locked
- active_lock_reason
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -109123,11 +111403,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -111377,11 +113657,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -112285,11 +114565,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -113333,11 +115613,11 @@ components:
required:
- state
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -115589,11 +117869,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -116574,11 +118854,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -117521,11 +119801,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -118560,11 +120840,11 @@ components:
- locked
- active_lock_reason
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -119468,11 +121748,11 @@ components:
- body
- reactions
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- issue
@@ -119523,11 +121803,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -119577,11 +121857,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -119663,11 +121943,11 @@ components:
- default
- description
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- label
@@ -119829,7 +122109,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -119911,9 +122191,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -120075,7 +122355,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -120159,9 +122439,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -120323,7 +122603,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -120406,9 +122686,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -120516,7 +122796,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -120598,9 +122878,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -120762,7 +123042,7 @@ components:
required:
- next_billing_date
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
previous_marketplace_purchase:
title: Marketplace Purchase
type: object
@@ -120844,9 +123124,9 @@ components:
- free_trial_ends_on
- plan
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- effective_date
@@ -120946,11 +123226,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- member
@@ -121058,11 +123338,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -121149,11 +123429,11 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- member
@@ -121239,9 +123519,9 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
scope:
description: The scope of the membership. Currently, can only be `team`.
type: string
@@ -121513,9 +123793,9 @@ components:
- login
- id
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
scope:
description: The scope of the membership. Currently, can only be `team`.
type: string
@@ -121720,11 +124000,11 @@ components:
merge_group:
"$ref": "#/components/schemas/merge-group"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- merge_group
@@ -121749,11 +124029,11 @@ components:
merge_group:
"$ref": "#/components/schemas/merge-group"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- merge_group
@@ -121877,11 +124157,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/nullable-repository"
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- hook_id
@@ -122035,11 +124315,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -122193,11 +124473,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -122352,11 +124632,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -122542,11 +124822,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -122701,11 +124981,11 @@ components:
- due_on
- closed_at
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- milestone
@@ -122791,11 +125071,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- blocked_user
@@ -122881,11 +125161,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- blocked_user
@@ -122993,11 +125273,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- organization
@@ -123104,11 +125384,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- membership
@@ -123239,11 +125519,11 @@ components:
- team_count
- invitation_teams_url
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
user:
title: User
type: object
@@ -123418,11 +125698,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- membership
@@ -123538,11 +125818,11 @@ components:
- organization_url
- user
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- organization
@@ -123593,7 +125873,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
package:
description: Information about the package.
type: object
@@ -124151,9 +126431,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- package
@@ -124171,7 +126451,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
package:
description: Information about the package.
type: object
@@ -124590,9 +126870,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- package
@@ -124712,11 +126992,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- id
- build
@@ -124733,9 +127013,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -124755,9 +127035,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -124777,9 +127057,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -124799,9 +127079,9 @@ components:
personal_access_token_request:
"$ref": "#/components/schemas/personal-access-token-request"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
installation:
"$ref": "#/components/schemas/simple-installation"
required:
@@ -124888,11 +127168,11 @@ components:
description: The ID of the webhook that triggered the ping.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
zen:
description: Random string of GitHub zen.
type: string
@@ -124931,7 +127211,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -125050,9 +127330,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -125071,7 +127351,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -125190,9 +127470,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -125210,7 +127490,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -125331,9 +127611,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/nullable-repository"
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -125364,7 +127644,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
title: Project Card
type: object
@@ -125483,9 +127763,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -125516,7 +127796,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_card:
allOf:
- title: Project Card
@@ -125705,9 +127985,9 @@ components:
required:
- after_id
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_card
@@ -125725,7 +128005,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -125849,9 +128129,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -125869,7 +128149,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -125910,9 +128190,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -125929,7 +128209,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -125970,9 +128250,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/nullable-repository"
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -125999,7 +128279,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -126040,9 +128320,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -126060,7 +128340,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project_column:
title: Project Column
type: object
@@ -126101,9 +128381,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project_column
@@ -126121,7 +128401,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -126245,9 +128525,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -126265,7 +128545,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -126389,9 +128669,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/nullable-repository"
+ "$ref": "#/components/schemas/nullable-repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -126429,7 +128709,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -126553,9 +128833,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -126572,7 +128852,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
project:
title: Project
type: object
@@ -126696,9 +128976,9 @@ components:
- created_at
- updated_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- project
@@ -126714,11 +128994,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -126735,11 +129015,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -126756,11 +129036,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -126812,11 +129092,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -126848,11 +129128,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -126881,11 +129161,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -126903,11 +129183,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -126924,11 +129204,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -126971,11 +129251,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -127004,11 +129284,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -127040,11 +129320,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2_item:
"$ref": "#/components/schemas/projects-v2-item"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2_item
@@ -127062,11 +129342,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
projects_v2:
"$ref": "#/components/schemas/projects-v2"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- projects_v2
@@ -127081,11 +129361,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- repository
- sender
@@ -127172,7 +129452,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -129414,9 +131694,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -129439,7 +131719,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -131678,9 +133958,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -131703,7 +133983,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -133943,9 +136223,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -133968,7 +136248,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -134033,9 +136313,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -134058,7 +136338,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -134123,9 +136403,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -134148,7 +136428,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -136377,9 +138657,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -136400,7 +138680,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -138630,9 +140910,9 @@ components:
reason:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -138698,7 +140978,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -138763,9 +141043,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -138787,7 +141067,7 @@ components:
number:
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -141015,9 +143295,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -141072,7 +143352,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -143315,9 +145595,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -143340,7 +145620,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -145581,9 +147861,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -145606,7 +147886,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -147835,9 +150115,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -147859,7 +150139,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -147924,9 +150204,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -147949,7 +150229,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -148014,9 +150294,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -148039,7 +150319,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
allOf:
- "$ref": "#/components/schemas/pull-request"
@@ -148104,9 +150384,9 @@ components:
type: boolean
default: false
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -148406,7 +150686,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -150541,9 +152821,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -150842,7 +153122,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -152965,9 +155245,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- comment
@@ -153278,7 +155558,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
type: object
properties:
@@ -155402,9 +157682,9 @@ components:
- author_association
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -155425,7 +157705,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -157563,7 +159843,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -157713,7 +159993,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- review
@@ -157745,7 +160025,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -159766,7 +162046,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -159912,7 +162192,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -159937,7 +162217,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -162173,7 +164453,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_reviewer:
title: User
type: object
@@ -162242,7 +164522,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_reviewer
- action
@@ -162264,7 +164544,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -164509,7 +166789,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_team:
title: Team
description: Groups of organization members that gives permissions on
@@ -164619,7 +166899,7 @@ components:
- repositories_url
- permission
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_team
- action
@@ -164644,7 +166924,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -166884,7 +169164,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_reviewer:
title: User
type: object
@@ -166954,7 +169234,7 @@ components:
- login
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_reviewer
- action
@@ -166976,7 +169256,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -169207,7 +171487,7 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
requested_team:
title: Team
description: Groups of organization members that gives permissions on
@@ -169308,7 +171588,7 @@ components:
- name
- id
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- requested_team
- action
@@ -169329,7 +171609,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -171469,7 +173749,7 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
review:
description: The review that was affected.
type: object
@@ -171615,7 +173895,7 @@ components:
- author_association
- _links
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- review
@@ -171635,7 +173915,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -173672,9 +175952,9 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
thread:
type: object
properties:
@@ -173986,7 +176266,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Simple Pull Request
type: object
@@ -176009,9 +178289,9 @@ components:
- auto_merge
- active_lock_reason
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
thread:
type: object
properties:
@@ -176328,7 +178608,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -178559,9 +180839,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -178654,7 +180934,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -180898,9 +183178,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -180954,7 +183234,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -183187,9 +185467,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -183212,7 +185492,7 @@ components:
description: The pull request number.
type: integer
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pull_request:
title: Pull Request
type: object
@@ -185438,9 +187718,9 @@ components:
- active_lock_reason
- draft
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- number
@@ -185664,7 +187944,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
pusher:
title: Committer
description: Metaproperties for Git author/committer information.
@@ -186145,7 +188425,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- ref
- before
@@ -186171,7 +188451,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
registry_package:
type: object
properties:
@@ -186667,9 +188947,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- registry_package
@@ -186686,7 +188966,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
registry_package:
type: object
properties:
@@ -187039,9 +189319,9 @@ components:
- package_version
- registry
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- registry_package
@@ -187059,7 +189339,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -187364,9 +189644,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -187385,7 +189665,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -187690,9 +189970,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -187741,7 +190021,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -188046,9 +190326,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -188067,7 +190347,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -188462,9 +190742,9 @@ components:
required:
- prerelease
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -188482,7 +190762,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -188874,9 +191154,9 @@ components:
required:
- published_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -188894,7 +191174,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
title: Release
description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release)
@@ -189199,9 +191479,9 @@ components:
- zipball_url
- body
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -189219,7 +191499,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
release:
allOf:
- title: Release
@@ -189610,9 +191890,9 @@ components:
required:
- published_at
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- release
@@ -189630,13 +191910,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_advisory:
"$ref": "#/components/schemas/repository-advisory"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189654,13 +191934,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_advisory:
"$ref": "#/components/schemas/repository-advisory"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189678,11 +191958,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189700,11 +191980,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189722,11 +192002,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189750,11 +192030,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- branch
@@ -189809,11 +192089,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -189828,11 +192108,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
status:
type: string
enum:
@@ -189856,11 +192136,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189878,11 +192158,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -189917,11 +192197,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -189940,13 +192220,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -189964,13 +192244,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -189988,9 +192268,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
repository_ruleset:
"$ref": "#/components/schemas/repository-ruleset"
changes:
@@ -190088,7 +192368,7 @@ components:
from:
type: string
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository_ruleset
@@ -190239,11 +192519,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- changes
@@ -190262,11 +192542,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -190439,11 +192719,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -190697,11 +192977,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -190875,11 +193155,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191059,11 +193339,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191084,11 +193364,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191108,11 +193388,11 @@ components:
location:
"$ref": "#/components/schemas/secret-scanning-location"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- location
- alert
@@ -191143,11 +193423,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191167,11 +193447,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191191,11 +193471,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- alert
@@ -191213,9 +193493,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -191327,7 +193607,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -191344,9 +193624,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -191458,7 +193738,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -191475,9 +193755,9 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
security_advisory:
description: The details of the security advisory, including summary, description,
and severity.
@@ -191588,7 +193868,7 @@ components:
- withdrawn_at
- vulnerabilities
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- security_advisory
@@ -191609,11 +193889,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
"$ref": "#/components/schemas/full-repository"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- changes
- repository
@@ -191630,11 +193910,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -191874,11 +194154,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -192130,11 +194410,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -192380,11 +194660,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -192672,11 +194952,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -192960,11 +195240,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sponsorship:
type: object
properties:
@@ -193205,11 +195485,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
starred_at:
description: 'The time the star was created. This is a timestamp in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted`
@@ -193234,11 +195514,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
starred_at:
description: 'The time the star was created. This is a timestamp in ISO
8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted`
@@ -193600,11 +195880,11 @@ components:
name:
type: string
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
sha:
description: The Commit SHA.
type: string
@@ -193645,11 +195925,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -193781,7 +196061,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -194230,7 +196510,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -194362,7 +196642,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -194811,7 +197091,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -194944,7 +197224,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -195393,7 +197673,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -195590,7 +197870,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -196039,7 +198319,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -196173,7 +198453,7 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
title: Repository
description: A git repository
@@ -196622,7 +198902,7 @@ components:
- topics
- visibility
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
team:
title: Team
description: Groups of organization members that gives permissions on specified
@@ -196755,11 +199035,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
required:
- action
- repository
@@ -196777,13 +199057,13 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
ref:
type: string
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
type: string
required:
@@ -196805,11 +199085,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
allOf:
- title: Workflow Job
@@ -197061,11 +199341,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
allOf:
- title: Workflow Job
@@ -197340,11 +199620,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
type: object
properties:
@@ -197498,11 +199778,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow_job:
type: object
properties:
@@ -197657,11 +199937,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type: object
@@ -199087,11 +201367,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type: object
@@ -200517,11 +202797,11 @@ components:
installation:
"$ref": "#/components/schemas/simple-installation"
organization:
- "$ref": "#/components/schemas/organization-simple"
+ "$ref": "#/components/schemas/organization-simple-webhooks"
repository:
- "$ref": "#/components/schemas/repository"
+ "$ref": "#/components/schemas/repository-webhooks"
sender:
- "$ref": "#/components/schemas/simple-user"
+ "$ref": "#/components/schemas/simple-user-webhooks"
workflow:
title: Workflow
type: object
@@ -201870,7 +204150,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -201916,7 +204196,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -202171,6 +204451,145 @@ components:
site_admin: false
has_multiple_single_files: false
single_file_paths: []
+ classroom-assignment:
+ value:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ deadline: '2011-01-26T19:06:43Z'
+ stater_code_repository:
+ id: 1296269
+ full_name: octocat/Hello-World
+ html_url: https://github.com/octocat/Hello-World
+ node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ private: false
+ default_branch: main
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom-accepted-assignment:
+ value:
+ id: 12,
+ submitted: false,
+ passing: false,
+ commit_count: 5
+ grade: 5/10
+ students:
+ - id: 1
+ login: octocat
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ html_url: https://github.com/octocat
+ repository:
+ id: 1296269
+ full_name: octocat/Hello-World
+ html_url: https://github.com/octocat/Hello-World
+ node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
+ private: false
+ default_branch: main
+ assignment:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom-assignment-grades:
+ value:
+ - assignment_name: Introduction to Strings
+ assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337
+ starter_code_url: ''
+ github_username: octocat
+ roster_identifier: octocat@github.com
+ student_repository_name: intro-to-strings-1337-octocat
+ student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-octocat
+ submission_timestamp: 2018-11-12 01:02
+ points_awarded: 10
+ points_available: 15
+ group_name: octocat-and-friends
+ - assignment_name: Introduction to Strings
+ assignment_url: https://classroom.github.com/classrooms/1337/assignments/1337
+ starter_code_url: ''
+ github_username: monalisa
+ roster_identifier: monalisa@github.com
+ student_repository_name: intro-to-strings-1337-monalisa
+ student_repository_url: https://github.com/timeforschool/intro-to-strings-1337-monalisa
+ submission_timestamp: 2018-11-12 01:11
+ points_awarded: 15
+ points_available: 15
+ group_name: monalisa-and-friends
+ simple-classroom:
+ value:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ classroom:
+ value:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ organization:
+ id: 1
+ login: programming-elixir
+ node_id: MDEyOk9yZ2FuaXphdGlvbjE=
+ html_url: https://github.com/programming-elixir
+ name: Learn how to build fault tolerant applications
+ avatar_url: https://avatars.githubusercontent.com/u/9919?v=4
+ url: https://classroom.github.com/classrooms/1-programming-elixir
+ simple-classroom-assignment:
+ value:
+ id: 12,
+ public_repo: false,
+ title: Intro to Binaries
+ type: individual
+ invite_link: https://classroom.github.com/a/Lx7jiUgx
+ invitations_enabled: true,
+ slug: intro-to-binaries
+ students_are_repo_admins: false
+ feedback_pull_requests_enabled: true
+ max_teams: 0
+ max_members: 0
+ editor: codespaces
+ accepted: 100
+ submitted: 40
+ passing: 10
+ language: ruby
+ deadline: '2020-01-11T11:59:22Z'
+ classroom:
+ id: 1296269
+ name: Programming Elixir
+ archived: false,
+ url: https://classroom.github.com/classrooms/1-programming-elixir
code-of-conduct-simple-items:
value:
- key: citizen_code_of_conduct
@@ -207492,7 +209911,7 @@ components:
type: Organization
site_admin: false
repository_selection: all
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -214189,6 +216608,30 @@ components:
storage_in_bytes: 68719476736
memory_in_bytes: 34359738368
cpus: 8
+ codespaces-default-attributes-for-a-codespace:
+ value:
+ billable_owner:
+ login: octocat
+ id: 1
+ node_id: MDQ6VXNlcjE=
+ avatar_url: https://github.com/images/error/octocat_happy.gif
+ gravatar_id: ''
+ url: https://api.github.com/users/octocat
+ html_url: https://github.com/octocat
+ followers_url: https://api.github.com/users/octocat/followers
+ following_url: https://api.github.com/users/octocat/following{/other_user}
+ gists_url: https://api.github.com/users/octocat/gists{/gist_id}
+ starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
+ subscriptions_url: https://api.github.com/users/octocat/subscriptions
+ organizations_url: https://api.github.com/users/octocat/orgs
+ repos_url: https://api.github.com/users/octocat/repos
+ events_url: https://api.github.com/users/octocat/events{/privacy}
+ received_events_url: https://api.github.com/users/octocat/received_events
+ type: User
+ site_admin: false
+ defaults:
+ location: EastUs
+ devcontainer_path: ".devcontainer/devcontainer.json"
collaborator-items:
value:
- login: octocat
@@ -216309,8 +218752,8 @@ components:
versionInfo: 1.0.0
downloadLocation: NOASSERTION
filesAnalyzed: false
- licenseConcluded: NOASSERTION
- licenseDeclared: NOASSERTION
+ licenseConcluded: MIT
+ licenseDeclared: MIT
dependency-graph-create-snapshot-request:
value:
version: 0
@@ -216629,6 +219072,26 @@ components:
id: 364663
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=
name: main
+ deployment-protection-rules:
+ value:
+ - total_count: 2
+ - custom_deployment_protection_rules:
+ - id: 3
+ node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv
+ enabled: true
+ app:
+ id: 1
+ node_id: GHT58kRlcGxveW1lbnRTdTY!bbcy
+ slug: a-custom-app
+ integration_url: https://api.github.com/apps/a-custom-app
+ - id: 4
+ node_id: MDE2OkRlcGxveW1lbnRTdHJ41128
+ enabled: true
+ app:
+ id: 1
+ node_id: UHVE67RlcGxveW1lbnRTdTY!jfeuy
+ slug: another-custom-app
+ integration_url: https://api.github.com/apps/another-custom-app
deployment-protection-rule:
value:
id: 3
@@ -224021,7 +226484,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -224065,7 +226528,7 @@ components:
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- access_tokens_url: https://api.github.com/installations/1/access_tokens
+ access_tokens_url: https://api.github.com/app/installations/1/access_tokens
repositories_url: https://api.github.com/installation/repositories
html_url: https://github.com/organizations/github/settings/installations/1
app_id: 1
@@ -227233,6 +229696,20 @@ components:
required: true
schema:
type: string
+ assignment-id:
+ name: assignment_id
+ description: The unique identifier of the classroom assignment.
+ in: path
+ required: true
+ schema:
+ type: integer
+ classroom-id:
+ name: classroom_id
+ description: The unique identifier of the classroom.
+ in: path
+ required: true
+ schema:
+ type: integer
enterprise:
name: enterprise
description: The slug version of the enterprise name. You can also substitute
diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts
index dd5673f9c..cc252740c 100644
--- a/packages/openapi-typescript/examples/stripe-api.ts
+++ b/packages/openapi-typescript/examples/stripe-api.ts
@@ -13,6 +13,10 @@ export interface paths {
/** @description Creates an AccountLink object that includes a single-use Stripe URL that the platform can redirect their user to in order to take them through the Connect Onboarding flow.
*/
post: operations["PostAccountLinks"];
};
+ "/v1/account_sessions": {
+ /** @description Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
*/
+ post: operations["PostAccountSessions"];
+ };
"/v1/accounts": {
/** @description Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
*/
get: operations["GetAccounts"];
@@ -74,7 +78,7 @@ export interface paths {
"/v1/accounts/{account}/capabilities/{capability}": {
/** @description Retrieves information about the specified Account Capability.
*/
get: operations["GetAccountsAccountCapabilitiesCapability"];
- /** @description Updates an existing Account Capability.
*/
+ /** @description Updates an existing Account Capability. Request or remove a capability by updating its requested
parameter.
*/
post: operations["PostAccountsAccountCapabilitiesCapability"];
};
"/v1/accounts/{account}/external_accounts": {
@@ -603,13 +607,13 @@ export interface paths {
"/v1/customers/{customer}/tax_ids": {
/** @description Returns a list of tax IDs for a customer.
*/
get: operations["GetCustomersCustomerTaxIds"];
- /** @description Creates a new TaxID
object for a customer.
*/
+ /** @description Creates a new tax_id
object for a customer.
*/
post: operations["PostCustomersCustomerTaxIds"];
};
"/v1/customers/{customer}/tax_ids/{id}": {
- /** @description Retrieves the TaxID
object with the given identifier.
*/
+ /** @description Retrieves the tax_id
object with the given identifier.
*/
get: operations["GetCustomersCustomerTaxIdsId"];
- /** @description Deletes an existing TaxID
object.
*/
+ /** @description Deletes an existing tax_id
object.
*/
delete: operations["DeleteCustomersCustomerTaxIdsId"];
};
"/v1/disputes": {
@@ -1014,9 +1018,9 @@ export interface paths {
/**
* @description Retrieves the details of a PaymentIntent that has previously been created.
*
- * Client-side retrieval using a publishable key is allowed when the client_secret
is provided in the query string.
+ * You can retrieve a PaymentIntent client-side using a publishable key when the client_secret
is in the query string.
*
- * When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.
+ * If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.
*/
get: operations["GetPaymentIntentsIntent"];
/**
@@ -1131,6 +1135,29 @@ export interface paths {
/** @description When retrieving a payment link, there is an includable line_items property containing the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.
*/
get: operations["GetPaymentLinksPaymentLinkLineItems"];
};
+ "/v1/payment_method_domains": {
+ /** @description Lists the details of existing payment method domains.
*/
+ get: operations["GetPaymentMethodDomains"];
+ /** @description Creates a payment method domain.
*/
+ post: operations["PostPaymentMethodDomains"];
+ };
+ "/v1/payment_method_domains/{payment_method_domain}": {
+ /** @description Retrieves the details of an existing payment method domain.
*/
+ get: operations["GetPaymentMethodDomainsPaymentMethodDomain"];
+ /** @description Updates an existing payment method domain.
*/
+ post: operations["PostPaymentMethodDomainsPaymentMethodDomain"];
+ };
+ "/v1/payment_method_domains/{payment_method_domain}/validate": {
+ /**
+ * @description Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.
+ * The payment method doesn’t appear in Elements for this domain until it is active.
+ *
+ * To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+ *
+ * Related guides: Payment method domains.
+ */
+ post: operations["PostPaymentMethodDomainsPaymentMethodDomainValidate"];
+ };
"/v1/payment_methods": {
/** @description Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
*/
get: operations["GetPaymentMethods"];
@@ -1727,6 +1754,26 @@ export interface paths {
/** @description Create an incoming testmode bank transfer
*/
post: operations["PostTestHelpersCustomersCustomerFundCashBalance"];
};
+ "/v1/test_helpers/issuing/authorizations": {
+ /** @description Create a test-mode authorization.
*/
+ post: operations["PostTestHelpersIssuingAuthorizations"];
+ };
+ "/v1/test_helpers/issuing/authorizations/{authorization}/capture": {
+ /** @description Capture a test-mode authorization.
*/
+ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationCapture"];
+ };
+ "/v1/test_helpers/issuing/authorizations/{authorization}/expire": {
+ /** @description Expire a test-mode Authorization.
*/
+ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationExpire"];
+ };
+ "/v1/test_helpers/issuing/authorizations/{authorization}/increment": {
+ /** @description Increment a test-mode Authorization.
*/
+ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationIncrement"];
+ };
+ "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": {
+ /** @description Reverse a test-mode Authorization.
*/
+ post: operations["PostTestHelpersIssuingAuthorizationsAuthorizationReverse"];
+ };
"/v1/test_helpers/issuing/cards/{card}/shipping/deliver": {
/** @description Updates the shipping status of the specified Issuing Card
object to delivered
.
*/
post: operations["PostTestHelpersIssuingCardsCardShippingDeliver"];
@@ -1743,6 +1790,18 @@ export interface paths {
/** @description Updates the shipping status of the specified Issuing Card
object to shipped
.
*/
post: operations["PostTestHelpersIssuingCardsCardShippingShip"];
};
+ "/v1/test_helpers/issuing/transactions/create_force_capture": {
+ /** @description Allows the user to capture an arbitrary amount, also known as a forced capture.
*/
+ post: operations["PostTestHelpersIssuingTransactionsCreateForceCapture"];
+ };
+ "/v1/test_helpers/issuing/transactions/create_unlinked_refund": {
+ /** @description Allows the user to refund an arbitrary amount, also known as a unlinked refund.
*/
+ post: operations["PostTestHelpersIssuingTransactionsCreateUnlinkedRefund"];
+ };
+ "/v1/test_helpers/issuing/transactions/{transaction}/refund": {
+ /** @description Refund a test-mode Transaction.
*/
+ post: operations["PostTestHelpersIssuingTransactionsTransactionRefund"];
+ };
"/v1/test_helpers/refunds/{refund}/expire": {
/** @description Expire a refund with a status of requires_action
.
*/
post: operations["PostTestHelpersRefundsRefundExpire"];
@@ -2413,7 +2472,7 @@ export interface components {
* @description Account Links are the means by which a Connect platform grants a connected account permission to access
* Stripe-hosted applications, such as Connect Onboarding.
*
- * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding)
+ * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)
*/
account_link: {
/**
@@ -2508,6 +2567,41 @@ export interface components {
/** @description SEPA creditor identifier that identifies the company making the payment. */
creditor_id?: string;
};
+ /**
+ * ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession
+ * @description An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
+ *
+ * We recommend that you create an AccountSession each time you need to display an embedded component
+ * to your user. Do not save AccountSessions to your database as they expire relatively
+ * quickly, and cannot be used more than once.
+ *
+ * Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
+ */
+ account_session: {
+ /** @description The ID of the account the AccountSession was created for */
+ account: string;
+ /**
+ * @description The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.
+ *
+ * The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.
+ *
+ * Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.
+ */
+ client_secret: string;
+ components: components["schemas"]["connect_embedded_account_session_create_components"];
+ /**
+ * Format: unix-time
+ * @description The timestamp at which this AccountSession will expire.
+ */
+ expires_at: number;
+ /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */
+ livemode: boolean;
+ /**
+ * @description String representing the object's type. Objects of the same type share the same value.
+ * @enum {string}
+ */
+ object: "account_session";
+ };
/** AccountSettings */
account_settings: {
bacs_debit_payments?: components["schemas"]["account_bacs_debit_payments_settings"];
@@ -2748,11 +2842,11 @@ export interface components {
* Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
*/
balance: {
- /** @description Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property. */
+ /** @description Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */
available: components["schemas"]["balance_amount"][];
- /** @description Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property. */
+ /** @description Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */
connect_reserved?: components["schemas"]["balance_amount"][];
- /** @description Funds that can be paid out using Instant Payouts. */
+ /** @description Funds that you can pay out using Instant Payouts. */
instant_available?: components["schemas"]["balance_amount"][];
issuing?: components["schemas"]["balance_detail"];
/** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */
@@ -2762,7 +2856,7 @@ export interface components {
* @enum {string}
*/
object: "balance";
- /** @description Funds that are not yet available in the balance. The pending balance for each currency, and for each payment type, can be found in the `source_types` property. */
+ /** @description Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property. */
pending: components["schemas"]["balance_amount"][];
};
/** BalanceAmount */
@@ -2829,7 +2923,7 @@ export interface components {
/** @description [Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective. */
reporting_category: string;
/** @description The Stripe object to which this transaction is related. */
- source?: (string | components["schemas"]["application_fee"] | components["schemas"]["charge"] | components["schemas"]["connect_collection_transfer"] | components["schemas"]["dispute"] | components["schemas"]["fee_refund"] | components["schemas"]["issuing.authorization"] | components["schemas"]["issuing.dispute"] | components["schemas"]["issuing.transaction"] | components["schemas"]["payout"] | components["schemas"]["platform_tax_fee"] | components["schemas"]["refund"] | components["schemas"]["reserve_transaction"] | components["schemas"]["tax_deducted_at_source"] | components["schemas"]["topup"] | components["schemas"]["transfer"] | components["schemas"]["transfer_reversal"]) | null;
+ source?: (string | components["schemas"]["application_fee"] | components["schemas"]["charge"] | components["schemas"]["connect_collection_transfer"] | components["schemas"]["customer_cash_balance_transaction"] | components["schemas"]["dispute"] | components["schemas"]["fee_refund"] | components["schemas"]["issuing.authorization"] | components["schemas"]["issuing.dispute"] | components["schemas"]["issuing.transaction"] | components["schemas"]["payout"] | components["schemas"]["platform_tax_fee"] | components["schemas"]["refund"] | components["schemas"]["reserve_transaction"] | components["schemas"]["tax_deducted_at_source"] | components["schemas"]["topup"] | components["schemas"]["transfer"] | components["schemas"]["transfer_reversal"]) | null;
/** @description If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`. */
status: string;
/**
@@ -3094,15 +3188,15 @@ export interface components {
};
/** CancellationDetails */
cancellation_details: {
- /** @description Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user. */
+ /** @description Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user. */
comment?: string | null;
/**
- * @description The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user.
+ * @description The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.
* @enum {string|null}
*/
feedback?: "customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused" | null;
/**
- * @description Why this subscription was cancelled.
+ * @description Why this subscription was canceled.
* @enum {string|null}
*/
reason?: "cancellation_requested" | "payment_disputed" | "payment_failed" | null;
@@ -4021,6 +4115,15 @@ export interface components {
*/
object: "connect_collection_transfer";
};
+ /** ConnectEmbeddedAccountSessionCreateComponents */
+ connect_embedded_account_session_create_components: {
+ account_onboarding: components["schemas"]["connect_embedded_base_config"];
+ };
+ /** ConnectEmbeddedBaseConfig */
+ connect_embedded_base_config: {
+ /** @description Whether the embedded component is enabled. */
+ enabled: boolean;
+ };
/**
* CountrySpec
* @description Stripe needs to collect certain pieces of information about each account
@@ -7144,6 +7247,8 @@ export interface components {
issuing_authorization_amount_details: {
/** @description The fee charged by the ATM for the cash withdrawal. */
atm_fee?: number | null;
+ /** @description The amount of cash requested by the cardholder. */
+ cashback_amount?: number | null;
};
/** IssuingAuthorizationMerchantData */
issuing_authorization_merchant_data: {
@@ -7596,6 +7701,8 @@ export interface components {
issuing_transaction_amount_details: {
/** @description The fee charged by the ATM for the cash withdrawal. */
atm_fee?: number | null;
+ /** @description The amount of cash requested by the cardholder. */
+ cashback_amount?: number | null;
};
/** IssuingTransactionFlightData */
issuing_transaction_flight_data: {
@@ -9783,15 +9890,15 @@ export interface components {
/** payment_method_details_ideal */
payment_method_details_ideal: {
/**
- * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+ * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
* @enum {string|null}
*/
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
/**
* @description The Bank Identifier Code of the customer's bank.
* @enum {string|null}
*/
- bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
+ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
/** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */
generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null;
/** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */
@@ -10039,6 +10146,57 @@ export interface components {
};
/** payment_method_details_zip */
payment_method_details_zip: Record;
+ /**
+ * PaymentMethodDomainResourcePaymentMethodDomain
+ * @description A payment method domain represents a web domain that you have registered with Stripe.
+ * Stripe Elements use registered payment method domains to control where certain payment methods are shown.
+ *
+ * Related guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
+ */
+ payment_method_domain: {
+ apple_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"];
+ /**
+ * Format: unix-time
+ * @description Time at which the object was created. Measured in seconds since the Unix epoch.
+ */
+ created: number;
+ /** @description The domain name that this payment method domain object represents. */
+ domain_name: string;
+ /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */
+ enabled: boolean;
+ google_pay: components["schemas"]["payment_method_domain_resource_payment_method_status"];
+ /** @description Unique identifier for the object. */
+ id: string;
+ link: components["schemas"]["payment_method_domain_resource_payment_method_status"];
+ /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */
+ livemode: boolean;
+ /**
+ * @description String representing the object's type. Objects of the same type share the same value.
+ * @enum {string}
+ */
+ object: "payment_method_domain";
+ paypal: components["schemas"]["payment_method_domain_resource_payment_method_status"];
+ };
+ /**
+ * PaymentMethodDomainResourcePaymentMethodStatus
+ * @description Indicates the status of a specific payment method on a payment method domain.
+ */
+ payment_method_domain_resource_payment_method_status: {
+ /**
+ * @description The status of the payment method on the domain.
+ * @enum {string}
+ */
+ status: "active" | "inactive";
+ status_details?: components["schemas"]["payment_method_domain_resource_payment_method_status_details"];
+ };
+ /**
+ * PaymentMethodDomainResourcePaymentMethodStatusDetails
+ * @description Contains additional details about the status of a payment method for a specific payment method domain.
+ */
+ payment_method_domain_resource_payment_method_status_details: {
+ /** @description The error message associated with the status of the payment method on the domain. */
+ error_message: string;
+ };
/** payment_method_eps */
payment_method_eps: {
/**
@@ -10062,15 +10220,15 @@ export interface components {
/** payment_method_ideal */
payment_method_ideal: {
/**
- * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+ * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
* @enum {string|null}
*/
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
/**
* @description The Bank Identifier Code of the customer's bank, if the bank was provided.
* @enum {string|null}
*/
- bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
+ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
};
/** payment_method_interac_present */
payment_method_interac_present: {
@@ -11035,7 +11193,7 @@ export interface components {
gender?: string | null;
/** @description Unique identifier for the object. */
id: string;
- /** @description Whether the person's `id_number` was provided. */
+ /** @description Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`). */
id_number_provided?: boolean;
/** @description Whether the person's `id_number_secondary` was provided. */
id_number_secondary_provided?: boolean;
@@ -11535,6 +11693,8 @@ export interface components {
default_price?: (string | components["schemas"]["price"]) | null;
/** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */
description?: string | null;
+ /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */
+ features: components["schemas"]["product_feature"][];
/** @description Unique identifier for the object. */
id: string;
/** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */
@@ -11570,6 +11730,11 @@ export interface components {
/** @description A URL of a publicly-accessible webpage for this product. */
url?: string | null;
};
+ /** ProductFeature */
+ product_feature: {
+ /** @description The feature's name. Up to 80 characters long. */
+ name: string;
+ };
/**
* PromotionCode
* @description A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to
@@ -12489,15 +12654,15 @@ export interface components {
/** setup_attempt_payment_method_details_ideal */
setup_attempt_payment_method_details_ideal: {
/**
- * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
+ * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.
* @enum {string|null}
*/
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe" | null;
/**
* @description The Bank Identifier Code of the customer's bank.
* @enum {string|null}
*/
- bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
+ bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U" | null;
/** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */
generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null;
/** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */
@@ -16281,6 +16446,43 @@ export interface operations {
};
};
};
+ /** @description Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
*/
+ PostAccountSessions: {
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The identifier of the account to create an Account Session for. */
+ account: string;
+ /**
+ * account_session_create_components_param
+ * @description Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
+ */
+ components: {
+ /** base_config_param */
+ account_onboarding?: {
+ enabled: boolean;
+ };
+ };
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["account_session"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
/** @description Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
*/
GetAccounts: {
parameters: {
@@ -17669,7 +17871,7 @@ export interface operations {
};
};
};
- /** @description Updates an existing Account Capability.
*/
+ /** @description Updates an existing Account Capability. Request or remove a capability by updating its requested
parameter.
*/
PostAccountsAccountCapabilitiesCapability: {
parameters: {
path: {
@@ -17682,7 +17884,11 @@ export interface operations {
"application/x-www-form-urlencoded": {
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
- /** @description Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays. */
+ /**
+ * @description To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.
+ *
+ * If a capability isn't permanent, you can remove it from the account by passing false. Most capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
+ */
requested?: boolean;
};
};
@@ -24907,7 +25113,7 @@ export interface operations {
};
};
};
- /** @description Creates a new TaxID
object for a customer.
*/
+ /** @description Creates a new tax_id
object for a customer.
*/
PostCustomersCustomerTaxIds: {
parameters: {
path: {
@@ -24944,7 +25150,7 @@ export interface operations {
};
};
};
- /** @description Retrieves the TaxID
object with the given identifier.
*/
+ /** @description Retrieves the tax_id
object with the given identifier.
*/
GetCustomersCustomerTaxIdsId: {
parameters: {
query?: {
@@ -24976,7 +25182,7 @@ export interface operations {
};
};
};
- /** @description Deletes an existing TaxID
object.
*/
+ /** @description Deletes an existing tax_id
object.
*/
DeleteCustomersCustomerTaxIdsId: {
parameters: {
path: {
@@ -25208,6 +25414,8 @@ export interface operations {
expand?: string[];
/** @description The ID of the Issuing Card you'd like to access using the resulting ephemeral key. */
issuing_card?: string;
+ /** @description A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information. */
+ nonce?: string;
/** @description The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key */
verification_session?: string;
};
@@ -29758,7 +29966,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -30199,14 +30407,14 @@ export interface operations {
/**
* @description Retrieves the details of a PaymentIntent that has previously been created.
*
- * Client-side retrieval using a publishable key is allowed when the client_secret
is provided in the query string.
+ * You can retrieve a PaymentIntent client-side using a publishable key when the client_secret
is in the query string.
*
- * When retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.
+ * If you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.
*/
GetPaymentIntentsIntent: {
parameters: {
query?: {
- /** @description The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source. */
+ /** @description The client secret of the PaymentIntent. It's required if you use a publishable key to retrieve the source. */
client_secret?: string;
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
@@ -30354,7 +30562,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -31017,7 +31225,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -32021,6 +32229,184 @@ export interface operations {
};
};
};
+ /** @description Lists the details of existing payment method domains.
*/
+ GetPaymentMethodDomains: {
+ parameters: {
+ query?: {
+ /** @description The domain name that this payment method domain object represents. */
+ domain_name?: string;
+ /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements */
+ enabled?: boolean;
+ /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */
+ ending_before?: string;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */
+ limit?: number;
+ /** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */
+ starting_after?: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": Record;
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": {
+ data: components["schemas"]["payment_method_domain"][];
+ /** @description True if this list has another page of items after this one that can be fetched. */
+ has_more: boolean;
+ /**
+ * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
+ * @enum {string}
+ */
+ object: "list";
+ /** @description The URL where this list can be accessed. */
+ url: string;
+ };
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Creates a payment method domain.
*/
+ PostPaymentMethodDomains: {
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The domain name that this payment method domain object represents. */
+ domain_name: string;
+ /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */
+ enabled?: boolean;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["payment_method_domain"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Retrieves the details of an existing payment method domain.
*/
+ GetPaymentMethodDomainsPaymentMethodDomain: {
+ parameters: {
+ query?: {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ path: {
+ payment_method_domain: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": Record;
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["payment_method_domain"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Updates an existing payment method domain.
*/
+ PostPaymentMethodDomainsPaymentMethodDomain: {
+ parameters: {
+ path: {
+ payment_method_domain: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements. */
+ enabled?: boolean;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["payment_method_domain"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /**
+ * @description Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.
+ * The payment method doesn’t appear in Elements for this domain until it is active.
+ *
+ * To activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
+ *
+ * Related guides: Payment method domains.
+ */
+ PostPaymentMethodDomainsPaymentMethodDomainValidate: {
+ parameters: {
+ path: {
+ payment_method_domain: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["payment_method_domain"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
/** @description Returns a list of PaymentMethods for Treasury flows. If you want to list the PaymentMethods attached to a Customer for payments, you should use the List a Customer’s PaymentMethods API instead.
*/
GetPaymentMethods: {
parameters: {
@@ -32208,7 +32594,7 @@ export interface operations {
*/
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/**
* param
@@ -33518,6 +33904,10 @@ export interface operations {
description?: string;
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
+ /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */
+ features?: {
+ name: string;
+ }[];
/** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */
id?: string;
/** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */
@@ -33671,6 +34061,10 @@ export interface operations {
description?: string | "";
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
+ /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */
+ features?: {
+ name: string;
+ }[] | "";
/** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */
images?: string[] | "";
/** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */
@@ -35678,7 +36072,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -36001,7 +36395,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -36328,7 +36722,7 @@ export interface operations {
/** param */
ideal?: {
/** @enum {string} */
- bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
+ bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe";
};
/** param */
interac_present?: Record;
@@ -40151,6 +40545,8 @@ export interface operations {
limit?: number;
/** @description A location ID to filter the response list to only readers at the specific location */
location?: string;
+ /** @description Filters readers by serial number */
+ serial_number?: string;
/** @description A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. */
starting_after?: string;
/** @description A status filter to filter readers to only offline or online readers */
@@ -40559,6 +40955,270 @@ export interface operations {
};
};
};
+ /** @description Create a test-mode authorization.
*/
+ PostTestHelpersIssuingAuthorizations: {
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ amount: number;
+ /**
+ * amount_details_specs
+ * @description Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).
+ */
+ amount_details?: {
+ atm_fee?: number;
+ cashback_amount?: number;
+ };
+ /**
+ * @description How the card details were provided. Defaults to online.
+ * @enum {string}
+ */
+ authorization_method?: "chip" | "contactless" | "keyed_in" | "online" | "swipe";
+ /** @description Card associated with this authorization. */
+ card: string;
+ /** @description The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */
+ currency?: string;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */
+ is_amount_controllable?: boolean;
+ /**
+ * merchant_data_specs
+ * @description Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
+ */
+ merchant_data?: {
+ /** @enum {string} */
+ category?: "ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards";
+ city?: string;
+ country?: string;
+ name?: string;
+ network_id?: string;
+ postal_code?: string;
+ state?: string;
+ terminal_id?: string;
+ };
+ /**
+ * network_data_specs
+ * @description Details about the authorization, such as identifiers, set by the card network.
+ */
+ network_data?: {
+ acquiring_institution_id?: string;
+ };
+ /**
+ * verification_data_specs
+ * @description Verifications that Stripe performed on information that the cardholder provided to the merchant.
+ */
+ verification_data?: {
+ /** @enum {string} */
+ address_line1_check?: "match" | "mismatch" | "not_provided";
+ /** @enum {string} */
+ address_postal_code_check?: "match" | "mismatch" | "not_provided";
+ /** @enum {string} */
+ cvc_check?: "match" | "mismatch" | "not_provided";
+ /** @enum {string} */
+ expiry_check?: "match" | "mismatch" | "not_provided";
+ };
+ /**
+ * @description The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized.
+ * @enum {string}
+ */
+ wallet?: "apple_pay" | "google_pay" | "samsung_pay";
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.authorization"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Capture a test-mode authorization.
*/
+ PostTestHelpersIssuingAuthorizationsAuthorizationCapture: {
+ parameters: {
+ path: {
+ authorization: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ capture_amount?: number;
+ /** @description Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows. */
+ close_authorization?: boolean;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /**
+ * purchase_details_specs
+ * @description Additional purchase information that is optionally provided by the merchant.
+ */
+ purchase_details?: {
+ /** flight_specs */
+ flight?: {
+ /** Format: unix-time */
+ departure_at?: number;
+ passenger_name?: string;
+ refundable?: boolean;
+ segments?: {
+ arrival_airport_code?: string;
+ carrier?: string;
+ departure_airport_code?: string;
+ flight_number?: string;
+ service_class?: string;
+ stopover_allowed?: boolean;
+ }[];
+ travel_agency?: string;
+ };
+ /** fuel_specs */
+ fuel?: {
+ /** @enum {string} */
+ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super";
+ /** @enum {string} */
+ unit?: "liter" | "us_gallon";
+ /** Format: decimal */
+ unit_cost_decimal?: string;
+ /** Format: decimal */
+ volume_decimal?: string;
+ };
+ /** lodging_specs */
+ lodging?: {
+ /** Format: unix-time */
+ check_in_at?: number;
+ nights?: number;
+ };
+ receipt?: {
+ description?: string;
+ /** Format: decimal */
+ quantity?: string;
+ total?: number;
+ unit_cost?: number;
+ }[];
+ reference?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.authorization"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Expire a test-mode Authorization.
*/
+ PostTestHelpersIssuingAuthorizationsAuthorizationExpire: {
+ parameters: {
+ path: {
+ authorization: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.authorization"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Increment a test-mode Authorization.
*/
+ PostTestHelpersIssuingAuthorizationsAuthorizationIncrement: {
+ parameters: {
+ path: {
+ authorization: string;
+ };
+ };
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /** @description The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ increment_amount: number;
+ /** @description If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization. */
+ is_amount_controllable?: boolean;
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.authorization"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Reverse a test-mode Authorization.
*/
+ PostTestHelpersIssuingAuthorizationsAuthorizationReverse: {
+ parameters: {
+ path: {
+ authorization: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /** @description The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ reverse_amount?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.authorization"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
/** @description Updates the shipping status of the specified Issuing Card
object to delivered
.
*/
PostTestHelpersIssuingCardsCardShippingDeliver: {
parameters: {
@@ -40679,6 +41339,224 @@ export interface operations {
};
};
};
+ /** @description Allows the user to capture an arbitrary amount, also known as a forced capture.
*/
+ PostTestHelpersIssuingTransactionsCreateForceCapture: {
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ amount: number;
+ /** @description Card associated with this transaction. */
+ card: string;
+ /** @description The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */
+ currency?: string;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /**
+ * merchant_data_specs
+ * @description Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
+ */
+ merchant_data?: {
+ /** @enum {string} */
+ category?: "ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards";
+ city?: string;
+ country?: string;
+ name?: string;
+ network_id?: string;
+ postal_code?: string;
+ state?: string;
+ terminal_id?: string;
+ };
+ /**
+ * purchase_details_specs
+ * @description Additional purchase information that is optionally provided by the merchant.
+ */
+ purchase_details?: {
+ /** flight_specs */
+ flight?: {
+ /** Format: unix-time */
+ departure_at?: number;
+ passenger_name?: string;
+ refundable?: boolean;
+ segments?: {
+ arrival_airport_code?: string;
+ carrier?: string;
+ departure_airport_code?: string;
+ flight_number?: string;
+ service_class?: string;
+ stopover_allowed?: boolean;
+ }[];
+ travel_agency?: string;
+ };
+ /** fuel_specs */
+ fuel?: {
+ /** @enum {string} */
+ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super";
+ /** @enum {string} */
+ unit?: "liter" | "us_gallon";
+ /** Format: decimal */
+ unit_cost_decimal?: string;
+ /** Format: decimal */
+ volume_decimal?: string;
+ };
+ /** lodging_specs */
+ lodging?: {
+ /** Format: unix-time */
+ check_in_at?: number;
+ nights?: number;
+ };
+ receipt?: {
+ description?: string;
+ /** Format: decimal */
+ quantity?: string;
+ total?: number;
+ unit_cost?: number;
+ }[];
+ reference?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.transaction"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Allows the user to refund an arbitrary amount, also known as a unlinked refund.
*/
+ PostTestHelpersIssuingTransactionsCreateUnlinkedRefund: {
+ requestBody: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ amount: number;
+ /** @description Card associated with this unlinked refund transaction. */
+ card: string;
+ /** @description The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). */
+ currency?: string;
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /**
+ * merchant_data_specs
+ * @description Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.
+ */
+ merchant_data?: {
+ /** @enum {string} */
+ category?: "ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards";
+ city?: string;
+ country?: string;
+ name?: string;
+ network_id?: string;
+ postal_code?: string;
+ state?: string;
+ terminal_id?: string;
+ };
+ /**
+ * purchase_details_specs
+ * @description Additional purchase information that is optionally provided by the merchant.
+ */
+ purchase_details?: {
+ /** flight_specs */
+ flight?: {
+ /** Format: unix-time */
+ departure_at?: number;
+ passenger_name?: string;
+ refundable?: boolean;
+ segments?: {
+ arrival_airport_code?: string;
+ carrier?: string;
+ departure_airport_code?: string;
+ flight_number?: string;
+ service_class?: string;
+ stopover_allowed?: boolean;
+ }[];
+ travel_agency?: string;
+ };
+ /** fuel_specs */
+ fuel?: {
+ /** @enum {string} */
+ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super";
+ /** @enum {string} */
+ unit?: "liter" | "us_gallon";
+ /** Format: decimal */
+ unit_cost_decimal?: string;
+ /** Format: decimal */
+ volume_decimal?: string;
+ };
+ /** lodging_specs */
+ lodging?: {
+ /** Format: unix-time */
+ check_in_at?: number;
+ nights?: number;
+ };
+ receipt?: {
+ description?: string;
+ /** Format: decimal */
+ quantity?: string;
+ total?: number;
+ unit_cost?: number;
+ }[];
+ reference?: string;
+ };
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.transaction"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
+ /** @description Refund a test-mode Transaction.
*/
+ PostTestHelpersIssuingTransactionsTransactionRefund: {
+ parameters: {
+ path: {
+ transaction: string;
+ };
+ };
+ requestBody?: {
+ content: {
+ "application/x-www-form-urlencoded": {
+ /** @description Specifies which fields in the response should be expanded. */
+ expand?: string[];
+ /** @description The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */
+ refund_amount?: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Successful response. */
+ 200: {
+ content: {
+ "application/json": components["schemas"]["issuing.transaction"];
+ };
+ };
+ /** @description Error response. */
+ default: {
+ content: {
+ "application/json": components["schemas"]["error"];
+ };
+ };
+ };
+ };
/** @description Expire a refund with a status of requires_action
.
*/
PostTestHelpersRefundsRefundExpire: {
parameters: {
@@ -43805,7 +44683,7 @@ export interface operations {
/** @description An optional description of what the webhook is used for. */
description?: string | "";
/** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */
- enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "invoiceitem.updated" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "sku.created" | "sku.deleted" | "sku.updated" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[];
+ enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "sku.created" | "sku.deleted" | "sku.updated" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[];
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
/** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */
@@ -43878,7 +44756,7 @@ export interface operations {
/** @description Disable the webhook endpoint if set to true. */
disabled?: boolean;
/** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */
- enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "invoiceitem.updated" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "sku.created" | "sku.deleted" | "sku.updated" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[];
+ enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "order.created" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "recipient.created" | "recipient.deleted" | "recipient.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "sku.created" | "sku.deleted" | "sku.updated" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[];
/** @description Specifies which fields in the response should be expanded. */
expand?: string[];
/** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */
diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml
index 0e375320b..d391d1a2a 100644
--- a/packages/openapi-typescript/examples/stripe-api.yaml
+++ b/packages/openapi-typescript/examples/stripe-api.yaml
@@ -1003,7 +1003,7 @@ components:
Related guide: [Connect
- Onboarding](https://stripe.com/docs/connect/connect-onboarding)
+ Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)
properties:
created:
description: >-
@@ -1333,6 +1333,76 @@ components:
title: AccountSepaDebitPaymentsSettings
type: object
x-expandableFields: []
+ account_session:
+ description: >-
+ An AccountSession allows a Connect platform to grant access to a
+ connected account in Connect embedded components.
+
+
+ We recommend that you create an AccountSession each time you need to
+ display an embedded component
+
+ to your user. Do not save AccountSessions to your database as they
+ expire relatively
+
+ quickly, and cannot be used more than once.
+
+
+ Related guide: [Connect embedded
+ components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
+ properties:
+ account:
+ description: The ID of the account the AccountSession was created for
+ maxLength: 5000
+ type: string
+ client_secret:
+ description: >-
+ The client secret of this AccountSession. Used on the client to set
+ up secure access to the given `account`.
+
+
+ The client secret can be used to provide access to `account` from
+ your frontend. It should not be stored, logged, or exposed to anyone
+ other than the connected account. Make sure that you have TLS
+ enabled on any page that includes the client secret.
+
+
+ Refer to our docs to [setup Connect embedded
+ components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
+ and learn about how `client_secret` should be handled.
+ maxLength: 5000
+ type: string
+ components:
+ $ref: >-
+ #/components/schemas/connect_embedded_account_session_create_components
+ expires_at:
+ description: The timestamp at which this AccountSession will expire.
+ format: unix-time
+ type: integer
+ livemode:
+ description: >-
+ Has the value `true` if the object exists in live mode or the value
+ `false` if the object exists in test mode.
+ type: boolean
+ object:
+ description: >-
+ String representing the object's type. Objects of the same type
+ share the same value.
+ enum:
+ - account_session
+ type: string
+ required:
+ - account
+ - client_secret
+ - components
+ - expires_at
+ - livemode
+ - object
+ title: ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession
+ type: object
+ x-expandableFields:
+ - components
+ x-resourceId: account_session
account_settings:
description: ''
properties:
@@ -1929,25 +1999,25 @@ components:
properties:
available:
description: >-
- Funds that are available to be transferred or paid out, whether
- automatically by Stripe or explicitly via the [Transfers
+ Available funds that you can transfer or pay out automatically by
+ Stripe or explicitly through the [Transfers
API](https://stripe.com/docs/api#transfers) or [Payouts
- API](https://stripe.com/docs/api#payouts). The available balance for
- each currency and payment type can be found in the `source_types`
- property.
+ API](https://stripe.com/docs/api#payouts). You can find the
+ available balance for each currency and payment type in the
+ `source_types` property.
items:
$ref: '#/components/schemas/balance_amount'
type: array
connect_reserved:
description: >-
Funds held due to negative balances on connected Custom accounts.
- The connect reserve balance for each currency and payment type can
- be found in the `source_types` property.
+ You can find the connect reserve balance for each currency and
+ payment type in the `source_types` property.
items:
$ref: '#/components/schemas/balance_amount'
type: array
instant_available:
- description: Funds that can be paid out using Instant Payouts.
+ description: Funds that you can pay out using Instant Payouts.
items:
$ref: '#/components/schemas/balance_amount'
type: array
@@ -1967,8 +2037,8 @@ components:
type: string
pending:
description: >-
- Funds that are not yet available in the balance. The pending balance
- for each currency, and for each payment type, can be found in the
+ Funds that aren't available in the balance yet. You can find the
+ pending balance for each currency and each payment type in the
`source_types` property.
items:
$ref: '#/components/schemas/balance_amount'
@@ -2129,6 +2199,7 @@ components:
- $ref: '#/components/schemas/application_fee'
- $ref: '#/components/schemas/charge'
- $ref: '#/components/schemas/connect_collection_transfer'
+ - $ref: '#/components/schemas/customer_cash_balance_transaction'
- $ref: '#/components/schemas/dispute'
- $ref: '#/components/schemas/fee_refund'
- $ref: '#/components/schemas/issuing.authorization'
@@ -2149,6 +2220,7 @@ components:
- $ref: '#/components/schemas/application_fee'
- $ref: '#/components/schemas/charge'
- $ref: '#/components/schemas/connect_collection_transfer'
+ - $ref: '#/components/schemas/customer_cash_balance_transaction'
- $ref: '#/components/schemas/dispute'
- $ref: '#/components/schemas/fee_refund'
- $ref: '#/components/schemas/issuing.authorization'
@@ -2934,14 +3006,14 @@ components:
comment:
description: >-
Additional comments about why the user canceled the subscription, if
- the subscription was cancelled explicitly by the user.
+ the subscription was canceled explicitly by the user.
maxLength: 5000
nullable: true
type: string
feedback:
description: >-
- The customer submitted reason for why they cancelled, if the
- subscription was cancelled explicitly by the user.
+ The customer submitted reason for why they canceled, if the
+ subscription was canceled explicitly by the user.
enum:
- customer_service
- low_quality
@@ -2954,7 +3026,7 @@ components:
nullable: true
type: string
reason:
- description: Why this subscription was cancelled.
+ description: Why this subscription was canceled.
enum:
- cancellation_requested
- payment_disputed
@@ -5483,6 +5555,28 @@ components:
type: object
x-expandableFields:
- destination
+ connect_embedded_account_session_create_components:
+ description: ''
+ properties:
+ account_onboarding:
+ $ref: '#/components/schemas/connect_embedded_base_config'
+ required:
+ - account_onboarding
+ title: ConnectEmbeddedAccountSessionCreateComponents
+ type: object
+ x-expandableFields:
+ - account_onboarding
+ connect_embedded_base_config:
+ description: ''
+ properties:
+ enabled:
+ description: Whether the embedded component is enabled.
+ type: boolean
+ required:
+ - enabled
+ title: ConnectEmbeddedBaseConfig
+ type: object
+ x-expandableFields: []
country_spec:
description: >-
Stripe needs to collect certain pieces of information about each account
@@ -13463,6 +13557,10 @@ components:
description: The fee charged by the ATM for the cash withdrawal.
nullable: true
type: integer
+ cashback_amount:
+ description: The amount of cash requested by the cardholder.
+ nullable: true
+ type: integer
title: IssuingAuthorizationAmountDetails
type: object
x-expandableFields: []
@@ -14506,7 +14604,6 @@ components:
- shipped
nullable: true
type: string
- x-stripeBypassValidation: true
tracking_number:
description: A tracking number for a card shipment.
maxLength: 5000
@@ -16478,6 +16575,10 @@ components:
description: The fee charged by the ATM for the cash withdrawal.
nullable: true
type: integer
+ cashback_amount:
+ description: The amount of cash requested by the cardholder.
+ nullable: true
+ type: integer
title: IssuingTransactionAmountDetails
type: object
x-expandableFields: []
@@ -22814,9 +22915,9 @@ components:
bank:
description: >-
The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`,
- `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`,
- `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or
- `yoursafe`.
+ `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`,
+ `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`,
+ or `yoursafe`.
enum:
- abn_amro
- asn_bank
@@ -22825,6 +22926,7 @@ components:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -22846,6 +22948,7 @@ components:
- INGBNL2A
- KNABNL2H
- MOYONL21
+ - NTSBDEB1
- RABONL2U
- RBRBNL21
- REVOIE23
@@ -23520,6 +23623,117 @@ components:
title: payment_method_details_zip
type: object
x-expandableFields: []
+ payment_method_domain:
+ description: >-
+ A payment method domain represents a web domain that you have registered
+ with Stripe.
+
+ Stripe Elements use registered payment method domains to control where
+ certain payment methods are shown.
+
+
+ Related guides: [Payment method
+ domains](https://stripe.com/docs/payments/payment-methods/pmd-registration).
+ properties:
+ apple_pay:
+ $ref: >-
+ #/components/schemas/payment_method_domain_resource_payment_method_status
+ created:
+ description: >-
+ Time at which the object was created. Measured in seconds since the
+ Unix epoch.
+ format: unix-time
+ type: integer
+ domain_name:
+ description: The domain name that this payment method domain object represents.
+ maxLength: 5000
+ type: string
+ enabled:
+ description: >-
+ Whether this payment method domain is enabled. If the domain is not
+ enabled, payment methods that require a payment method domain will
+ not appear in Elements.
+ type: boolean
+ google_pay:
+ $ref: >-
+ #/components/schemas/payment_method_domain_resource_payment_method_status
+ id:
+ description: Unique identifier for the object.
+ maxLength: 5000
+ type: string
+ link:
+ $ref: >-
+ #/components/schemas/payment_method_domain_resource_payment_method_status
+ livemode:
+ description: >-
+ Has the value `true` if the object exists in live mode or the value
+ `false` if the object exists in test mode.
+ type: boolean
+ object:
+ description: >-
+ String representing the object's type. Objects of the same type
+ share the same value.
+ enum:
+ - payment_method_domain
+ type: string
+ paypal:
+ $ref: >-
+ #/components/schemas/payment_method_domain_resource_payment_method_status
+ required:
+ - apple_pay
+ - created
+ - domain_name
+ - enabled
+ - google_pay
+ - id
+ - link
+ - livemode
+ - object
+ - paypal
+ title: PaymentMethodDomainResourcePaymentMethodDomain
+ type: object
+ x-expandableFields:
+ - apple_pay
+ - google_pay
+ - link
+ - paypal
+ x-resourceId: payment_method_domain
+ payment_method_domain_resource_payment_method_status:
+ description: >-
+ Indicates the status of a specific payment method on a payment method
+ domain.
+ properties:
+ status:
+ description: The status of the payment method on the domain.
+ enum:
+ - active
+ - inactive
+ type: string
+ status_details:
+ $ref: >-
+ #/components/schemas/payment_method_domain_resource_payment_method_status_details
+ required:
+ - status
+ title: PaymentMethodDomainResourcePaymentMethodStatus
+ type: object
+ x-expandableFields:
+ - status_details
+ payment_method_domain_resource_payment_method_status_details:
+ description: >-
+ Contains additional details about the status of a payment method for a
+ specific payment method domain.
+ properties:
+ error_message:
+ description: >-
+ The error message associated with the status of the payment method
+ on the domain.
+ maxLength: 5000
+ type: string
+ required:
+ - error_message
+ title: PaymentMethodDomainResourcePaymentMethodStatusDetails
+ type: object
+ x-expandableFields: []
payment_method_eps:
description: ''
properties:
@@ -23632,8 +23846,8 @@ components:
description: >-
The customer's bank, if provided. Can be one of `abn_amro`,
`asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`,
- `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`,
- `van_lanschot`, or `yoursafe`.
+ `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`,
+ `triodos_bank`, `van_lanschot`, or `yoursafe`.
enum:
- abn_amro
- asn_bank
@@ -23642,6 +23856,7 @@ components:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -23665,6 +23880,7 @@ components:
- INGBNL2A
- KNABNL2H
- MOYONL21
+ - NTSBDEB1
- RABONL2U
- RBRBNL21
- REVOIE23
@@ -26442,7 +26658,11 @@ components:
maxLength: 5000
type: string
id_number_provided:
- description: Whether the person's `id_number` was provided.
+ description: >-
+ Whether the person's `id_number` was provided. True if either the
+ full ID number was provided or if only the required part of the ID
+ number was provided (ex. last four of an individual's SSN for the US
+ indicated by `ssn_last_4_provided`).
type: boolean
id_number_secondary_provided:
description: Whether the person's `id_number_secondary` was provided.
@@ -27773,6 +27993,14 @@ components:
maxLength: 5000
nullable: true
type: string
+ features:
+ description: >-
+ A list of up to 15 features for this product. These are displayed in
+ [pricing
+ tables](https://stripe.com/docs/payments/checkout/pricing-table).
+ items:
+ $ref: '#/components/schemas/product_feature'
+ type: array
id:
description: Unique identifier for the object.
maxLength: 5000
@@ -27859,6 +28087,7 @@ components:
required:
- active
- created
+ - features
- id
- images
- livemode
@@ -27870,9 +28099,22 @@ components:
type: object
x-expandableFields:
- default_price
+ - features
- package_dimensions
- tax_code
x-resourceId: product
+ product_feature:
+ description: ''
+ properties:
+ name:
+ description: The feature's name. Up to 80 characters long.
+ maxLength: 5000
+ type: string
+ required:
+ - name
+ title: ProductFeature
+ type: object
+ x-expandableFields: []
promotion_code:
description: >-
A Promotion Code represents a customer-redeemable code for a
@@ -30258,9 +30500,9 @@ components:
bank:
description: >-
The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`,
- `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`,
- `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or
- `yoursafe`.
+ `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`,
+ `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`,
+ or `yoursafe`.
enum:
- abn_amro
- asn_bank
@@ -30269,6 +30511,7 @@ components:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -30290,6 +30533,7 @@ components:
- INGBNL2A
- KNABNL2H
- MOYONL21
+ - NTSBDEB1
- RABONL2U
- RBRBNL21
- REVOIE23
@@ -39888,6 +40132,71 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
+ /v1/account_sessions:
+ post:
+ description: >-
+ Creates a AccountSession object that includes a single-use token that
+ the platform can use on their front-end to grant client-side API
+ access.
+ operationId: PostAccountSessions
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ components:
+ explode: true
+ style: deepObject
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ account:
+ description: >-
+ The identifier of the account to create an Account Session
+ for.
+ type: string
+ components:
+ description: >-
+ Each key of the dictionary represents an embedded component,
+ and each embedded component maps to its configuration (e.g.
+ whether it has been enabled or not).
+ properties:
+ account_onboarding:
+ properties:
+ enabled:
+ type: boolean
+ required:
+ - enabled
+ title: base_config_param
+ type: object
+ title: account_session_create_components_param
+ type: object
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ required:
+ - account
+ - components
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/account_session'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
/v1/accounts:
get:
description: >-
@@ -42792,7 +43101,9 @@ paths:
$ref: '#/components/schemas/error'
description: Error response.
post:
- description: Updates an existing Account Capability.
+ description: >-
+ Updates an existing Account Capability. Request or remove a
+ capability by updating its requested
parameter.
operationId: PostAccountsAccountCapabilitiesCapability
parameters:
- in: path
@@ -42826,10 +43137,16 @@ paths:
type: array
requested:
description: >-
- Passing true requests the capability for the account, if it
- is not already requested. A requested capability may not
- immediately become active. Any requirements to activate the
- capability are returned in the `requirements` arrays.
+ To request a new capability for an account, pass true. There
+ can be a delay before the requested capability becomes
+ active. If the capability has any activation requirements,
+ the response includes them in the `requirements` arrays.
+
+
+ If a capability isn't permanent, you can remove it from the
+ account by passing false. Most capabilities are permanent
+ after they've been requested. Attempting to remove a
+ permanent capability returns an error.
type: boolean
type: object
required: false
@@ -59414,7 +59731,7 @@ paths:
$ref: '#/components/schemas/error'
description: Error response.
post:
- description: Creates a new TaxID
object for a customer.
+ description: Creates a new tax_id
object for a customer.
operationId: PostCustomersCustomerTaxIds
parameters:
- in: path
@@ -59548,7 +59865,7 @@ paths:
description: Error response.
'/v1/customers/{customer}/tax_ids/{id}':
delete:
- description: Deletes an existing TaxID
object.
+ description: Deletes an existing tax_id
object.
operationId: DeleteCustomersCustomerTaxIdsId
parameters:
- in: path
@@ -59588,7 +59905,7 @@ paths:
description: Error response.
get:
description: >-
- Retrieves the TaxID
object with the given
+
Retrieves the tax_id
object with the given
identifier.
operationId: GetCustomersCustomerTaxIdsId
parameters:
@@ -60073,6 +60390,13 @@ paths:
resulting ephemeral key.
maxLength: 5000
type: string
+ nonce:
+ description: >-
+ A single-use token, created by Stripe.js, used for creating
+ ephemeral keys for Issuing Cards without exchanging
+ sensitive information.
+ maxLength: 5000
+ type: string
verification_session:
description: >-
The ID of the Identity VerificationSession you'd like to
@@ -75007,6 +75331,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -76360,19 +76685,19 @@ paths:
created.
- Client-side retrieval using a publishable key is allowed when the
- client_secret
is provided in the query string.
+ You can retrieve a PaymentIntent client-side using a publishable key
+ when the client_secret
is in the query string.
- When retrieved with a publishable key, only a subset of properties
- will be returned. Please refer to the If you retrieve a PaymentIntent with a publishable key, it only
+ returns a subset of properties. Refer to the payment intent object reference for
more details.
operationId: GetPaymentIntentsIntent
parameters:
- description: >-
- The client secret of the PaymentIntent. Required if a publishable
- key is used to retrieve the source.
+ The client secret of the PaymentIntent. It's required if you use a
+ publishable key to retrieve the source.
in: query
name: client_secret
required: false
@@ -76801,6 +77126,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -78727,6 +79053,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -81909,6 +82236,327 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
+ /v1/payment_method_domains:
+ get:
+ description: Lists the details of existing payment method domains.
+ operationId: GetPaymentMethodDomains
+ parameters:
+ - description: The domain name that this payment method domain object represents.
+ in: query
+ name: domain_name
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ - description: >-
+ Whether this payment method domain is enabled. If the domain is not
+ enabled, payment methods will not appear in Elements
+ in: query
+ name: enabled
+ required: false
+ schema:
+ type: boolean
+ style: form
+ - description: >-
+ A cursor for use in pagination. `ending_before` is an object ID that
+ defines your place in the list. For instance, if you make a list
+ request and receive 100 objects, starting with `obj_bar`, your
+ subsequent call can include `ending_before=obj_bar` in order to
+ fetch the previous page of the list.
+ in: query
+ name: ending_before
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ - description: Specifies which fields in the response should be expanded.
+ explode: true
+ in: query
+ name: expand
+ required: false
+ schema:
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ style: deepObject
+ - description: >-
+ A limit on the number of objects to be returned. Limit can range
+ between 1 and 100, and the default is 10.
+ in: query
+ name: limit
+ required: false
+ schema:
+ type: integer
+ style: form
+ - description: >-
+ A cursor for use in pagination. `starting_after` is an object ID
+ that defines your place in the list. For instance, if you make a
+ list request and receive 100 objects, ending with `obj_foo`, your
+ subsequent call can include `starting_after=obj_foo` in order to
+ fetch the next page of the list.
+ in: query
+ name: starting_after
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding: {}
+ schema:
+ additionalProperties: false
+ properties: {}
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ description: ''
+ properties:
+ data:
+ items:
+ $ref: '#/components/schemas/payment_method_domain'
+ type: array
+ has_more:
+ description: >-
+ True if this list has another page of items after this one
+ that can be fetched.
+ type: boolean
+ object:
+ description: >-
+ String representing the object's type. Objects of the same
+ type share the same value. Always has the value `list`.
+ enum:
+ - list
+ type: string
+ url:
+ description: The URL where this list can be accessed.
+ maxLength: 5000
+ pattern: ^/v1/payment_method_domains
+ type: string
+ required:
+ - data
+ - has_more
+ - object
+ - url
+ title: PaymentMethodDomainResourcePaymentMethodDomainList
+ type: object
+ x-expandableFields:
+ - data
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ post:
+ description: Creates a payment method domain.
+ operationId: PostPaymentMethodDomains
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ domain_name:
+ description: >-
+ The domain name that this payment method domain object
+ represents.
+ maxLength: 5000
+ type: string
+ enabled:
+ description: >-
+ Whether this payment method domain is enabled. If the domain
+ is not enabled, payment methods that require a payment
+ method domain will not appear in Elements.
+ type: boolean
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ required:
+ - domain_name
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/payment_method_domain'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/payment_method_domains/{payment_method_domain}':
+ get:
+ description: Retrieves the details of an existing payment method domain.
+ operationId: GetPaymentMethodDomainsPaymentMethodDomain
+ parameters:
+ - description: Specifies which fields in the response should be expanded.
+ explode: true
+ in: query
+ name: expand
+ required: false
+ schema:
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ style: deepObject
+ - in: path
+ name: payment_method_domain
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding: {}
+ schema:
+ additionalProperties: false
+ properties: {}
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/payment_method_domain'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ post:
+ description: Updates an existing payment method domain.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomain
+ parameters:
+ - in: path
+ name: payment_method_domain
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ enabled:
+ description: >-
+ Whether this payment method domain is enabled. If the domain
+ is not enabled, payment methods that require a payment
+ method domain will not appear in Elements.
+ type: boolean
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/payment_method_domain'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/payment_method_domains/{payment_method_domain}/validate':
+ post:
+ description: >-
+ Some payment methods such as Apple Pay require additional steps to
+ verify a domain. If the requirements weren’t satisfied when the domain
+ was created, the payment method will be inactive on the domain.
+
+ The payment method doesn’t appear in Elements for this domain until it
+ is active.
+
+
+ To activate a payment method on an existing payment method domain,
+ complete the required validation steps specific to the payment method,
+ and then validate the payment method domain with this endpoint.
+
+
+ Related guides: Payment method
+ domains.
+ operationId: PostPaymentMethodDomainsPaymentMethodDomainValidate
+ parameters:
+ - in: path
+ name: payment_method_domain
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/payment_method_domain'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
/v1/payment_methods:
get:
description: >-
@@ -82513,6 +83161,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -85261,6 +85910,9 @@ paths:
expand:
explode: true
style: deepObject
+ features:
+ explode: true
+ style: deepObject
images:
explode: true
style: deepObject
@@ -85386,6 +86038,21 @@ paths:
maxLength: 5000
type: string
type: array
+ features:
+ description: >-
+ A list of up to 15 features for this product. These are
+ displayed in [pricing
+ tables](https://stripe.com/docs/payments/checkout/pricing-table).
+ items:
+ properties:
+ name:
+ maxLength: 5000
+ type: string
+ required:
+ - name
+ title: features
+ type: object
+ type: array
id:
description: >-
An identifier will be randomly generated by Stripe. You can
@@ -85707,6 +86374,9 @@ paths:
expand:
explode: true
style: deepObject
+ features:
+ explode: true
+ style: deepObject
images:
explode: true
style: deepObject
@@ -85755,6 +86425,25 @@ paths:
maxLength: 5000
type: string
type: array
+ features:
+ anyOf:
+ - items:
+ properties:
+ name:
+ maxLength: 5000
+ type: string
+ required:
+ - name
+ title: features
+ type: object
+ type: array
+ - enum:
+ - ''
+ type: string
+ description: >-
+ A list of up to 15 features for this product. These are
+ displayed in [pricing
+ tables](https://stripe.com/docs/payments/checkout/pricing-table).
images:
anyOf:
- items:
@@ -90734,6 +91423,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -91589,6 +92279,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -92431,6 +93122,7 @@ paths:
- ing
- knab
- moneyou
+ - n26
- rabobank
- regiobank
- revolut
@@ -101447,6 +102139,14 @@ paths:
maxLength: 5000
type: string
style: form
+ - description: Filters readers by serial number
+ in: query
+ name: serial_number
+ required: false
+ schema:
+ maxLength: 5000
+ type: string
+ style: form
- description: >-
A cursor for use in pagination. `starting_after` is an object ID
that defines your place in the list. For instance, if you make a
@@ -102167,15 +102867,493 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
- '/v1/test_helpers/issuing/cards/{card}/shipping/deliver':
+ /v1/test_helpers/issuing/authorizations:
post:
- description: >-
- Updates the shipping status of the specified Issuing
- Card
object to delivered
.
- operationId: PostTestHelpersIssuingCardsCardShippingDeliver
+ description: Create a test-mode authorization.
+ operationId: PostTestHelpersIssuingAuthorizations
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ amount_details:
+ explode: true
+ style: deepObject
+ expand:
+ explode: true
+ style: deepObject
+ merchant_data:
+ explode: true
+ style: deepObject
+ network_data:
+ explode: true
+ style: deepObject
+ verification_data:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ amount:
+ description: >-
+ The total amount to attempt to authorize. This amount is in
+ the provided currency, or defaults to the cards currency,
+ and in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ amount_details:
+ description: >-
+ Detailed breakdown of amount components. These amounts are
+ denominated in `currency` and in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ properties:
+ atm_fee:
+ type: integer
+ cashback_amount:
+ type: integer
+ title: amount_details_specs
+ type: object
+ authorization_method:
+ description: How the card details were provided. Defaults to online.
+ enum:
+ - chip
+ - contactless
+ - keyed_in
+ - online
+ - swipe
+ type: string
+ card:
+ description: Card associated with this authorization.
+ maxLength: 5000
+ type: string
+ currency:
+ description: >-
+ The currency of the authorization. If not provided, defaults
+ to the currency of the card. Three-letter [ISO currency
+ code](https://www.iso.org/iso-4217-currency-codes.html), in
+ lowercase. Must be a [supported
+ currency](https://stripe.com/docs/currencies).
+ type: string
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ is_amount_controllable:
+ description: >-
+ If set `true`, you may provide
+ [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount)
+ to control how much to hold for the authorization.
+ type: boolean
+ merchant_data:
+ description: >-
+ Details about the seller (grocery store, e-commerce website,
+ etc.) where the card authorization happened.
+ properties:
+ category:
+ enum:
+ - ac_refrigeration_repair
+ - accounting_bookkeeping_services
+ - advertising_services
+ - agricultural_cooperative
+ - airlines_air_carriers
+ - airports_flying_fields
+ - ambulance_services
+ - amusement_parks_carnivals
+ - antique_reproductions
+ - antique_shops
+ - aquariums
+ - architectural_surveying_services
+ - art_dealers_and_galleries
+ - artists_supply_and_craft_shops
+ - auto_and_home_supply_stores
+ - auto_body_repair_shops
+ - auto_paint_shops
+ - auto_service_shops
+ - automated_cash_disburse
+ - automated_fuel_dispensers
+ - automobile_associations
+ - automotive_parts_and_accessories_stores
+ - automotive_tire_stores
+ - bail_and_bond_payments
+ - bakeries
+ - bands_orchestras
+ - barber_and_beauty_shops
+ - betting_casino_gambling
+ - bicycle_shops
+ - billiard_pool_establishments
+ - boat_dealers
+ - boat_rentals_and_leases
+ - book_stores
+ - books_periodicals_and_newspapers
+ - bowling_alleys
+ - bus_lines
+ - business_secretarial_schools
+ - buying_shopping_services
+ - cable_satellite_and_other_pay_television_and_radio
+ - camera_and_photographic_supply_stores
+ - candy_nut_and_confectionery_stores
+ - car_and_truck_dealers_new_used
+ - car_and_truck_dealers_used_only
+ - car_rental_agencies
+ - car_washes
+ - carpentry_services
+ - carpet_upholstery_cleaning
+ - caterers
+ - >-
+ charitable_and_social_service_organizations_fundraising
+ - chemicals_and_allied_products
+ - child_care_services
+ - childrens_and_infants_wear_stores
+ - chiropodists_podiatrists
+ - chiropractors
+ - cigar_stores_and_stands
+ - civic_social_fraternal_associations
+ - cleaning_and_maintenance
+ - clothing_rental
+ - colleges_universities
+ - commercial_equipment
+ - commercial_footwear
+ - commercial_photography_art_and_graphics
+ - commuter_transport_and_ferries
+ - computer_network_services
+ - computer_programming
+ - computer_repair
+ - computer_software_stores
+ - computers_peripherals_and_software
+ - concrete_work_services
+ - construction_materials
+ - consulting_public_relations
+ - correspondence_schools
+ - cosmetic_stores
+ - counseling_services
+ - country_clubs
+ - courier_services
+ - court_costs
+ - credit_reporting_agencies
+ - cruise_lines
+ - dairy_products_stores
+ - dance_hall_studios_schools
+ - dating_escort_services
+ - dentists_orthodontists
+ - department_stores
+ - detective_agencies
+ - digital_goods_applications
+ - digital_goods_games
+ - digital_goods_large_volume
+ - digital_goods_media
+ - direct_marketing_catalog_merchant
+ - >-
+ direct_marketing_combination_catalog_and_retail_merchant
+ - direct_marketing_inbound_telemarketing
+ - direct_marketing_insurance_services
+ - direct_marketing_other
+ - direct_marketing_outbound_telemarketing
+ - direct_marketing_subscription
+ - direct_marketing_travel
+ - discount_stores
+ - doctors
+ - door_to_door_sales
+ - drapery_window_covering_and_upholstery_stores
+ - drinking_places
+ - drug_stores_and_pharmacies
+ - drugs_drug_proprietaries_and_druggist_sundries
+ - dry_cleaners
+ - durable_goods
+ - duty_free_stores
+ - eating_places_restaurants
+ - educational_services
+ - electric_razor_stores
+ - electric_vehicle_charging
+ - electrical_parts_and_equipment
+ - electrical_services
+ - electronics_repair_shops
+ - electronics_stores
+ - elementary_secondary_schools
+ - emergency_services_gcas_visa_use_only
+ - employment_temp_agencies
+ - equipment_rental
+ - exterminating_services
+ - family_clothing_stores
+ - fast_food_restaurants
+ - financial_institutions
+ - fines_government_administrative_entities
+ - fireplace_fireplace_screens_and_accessories_stores
+ - floor_covering_stores
+ - florists
+ - florists_supplies_nursery_stock_and_flowers
+ - freezer_and_locker_meat_provisioners
+ - fuel_dealers_non_automotive
+ - funeral_services_crematories
+ - >-
+ furniture_home_furnishings_and_equipment_stores_except_appliances
+ - furniture_repair_refinishing
+ - furriers_and_fur_shops
+ - general_services
+ - gift_card_novelty_and_souvenir_shops
+ - glass_paint_and_wallpaper_stores
+ - glassware_crystal_stores
+ - golf_courses_public
+ - government_licensed_horse_dog_racing_us_region_only
+ - >-
+ government_licensed_online_casions_online_gambling_us_region_only
+ - government_owned_lotteries_non_us_region
+ - government_owned_lotteries_us_region_only
+ - government_services
+ - grocery_stores_supermarkets
+ - hardware_equipment_and_supplies
+ - hardware_stores
+ - health_and_beauty_spas
+ - hearing_aids_sales_and_supplies
+ - heating_plumbing_a_c
+ - hobby_toy_and_game_shops
+ - home_supply_warehouse_stores
+ - hospitals
+ - hotels_motels_and_resorts
+ - household_appliance_stores
+ - industrial_supplies
+ - information_retrieval_services
+ - insurance_default
+ - insurance_underwriting_premiums
+ - intra_company_purchases
+ - jewelry_stores_watches_clocks_and_silverware_stores
+ - landscaping_services
+ - laundries
+ - laundry_cleaning_services
+ - legal_services_attorneys
+ - luggage_and_leather_goods_stores
+ - lumber_building_materials_stores
+ - manual_cash_disburse
+ - marinas_service_and_supplies
+ - marketplaces
+ - masonry_stonework_and_plaster
+ - massage_parlors
+ - medical_and_dental_labs
+ - >-
+ medical_dental_ophthalmic_and_hospital_equipment_and_supplies
+ - medical_services
+ - membership_organizations
+ - mens_and_boys_clothing_and_accessories_stores
+ - mens_womens_clothing_stores
+ - metal_service_centers
+ - miscellaneous_apparel_and_accessory_shops
+ - miscellaneous_auto_dealers
+ - miscellaneous_business_services
+ - miscellaneous_food_stores
+ - miscellaneous_general_merchandise
+ - miscellaneous_general_services
+ - miscellaneous_home_furnishing_specialty_stores
+ - miscellaneous_publishing_and_printing
+ - miscellaneous_recreation_services
+ - miscellaneous_repair_shops
+ - miscellaneous_specialty_retail
+ - mobile_home_dealers
+ - motion_picture_theaters
+ - motor_freight_carriers_and_trucking
+ - motor_homes_dealers
+ - motor_vehicle_supplies_and_new_parts
+ - motorcycle_shops_and_dealers
+ - motorcycle_shops_dealers
+ - >-
+ music_stores_musical_instruments_pianos_and_sheet_music
+ - news_dealers_and_newsstands
+ - non_fi_money_orders
+ - non_fi_stored_value_card_purchase_load
+ - nondurable_goods
+ - nurseries_lawn_and_garden_supply_stores
+ - nursing_personal_care
+ - office_and_commercial_furniture
+ - opticians_eyeglasses
+ - optometrists_ophthalmologist
+ - orthopedic_goods_prosthetic_devices
+ - osteopaths
+ - package_stores_beer_wine_and_liquor
+ - paints_varnishes_and_supplies
+ - parking_lots_garages
+ - passenger_railways
+ - pawn_shops
+ - pet_shops_pet_food_and_supplies
+ - petroleum_and_petroleum_products
+ - photo_developing
+ - >-
+ photographic_photocopy_microfilm_equipment_and_supplies
+ - photographic_studios
+ - picture_video_production
+ - piece_goods_notions_and_other_dry_goods
+ - plumbing_heating_equipment_and_supplies
+ - political_organizations
+ - postal_services_government_only
+ - precious_stones_and_metals_watches_and_jewelry
+ - professional_services
+ - public_warehousing_and_storage
+ - quick_copy_repro_and_blueprint
+ - railroads
+ - real_estate_agents_and_managers_rentals
+ - record_stores
+ - recreational_vehicle_rentals
+ - religious_goods_stores
+ - religious_organizations
+ - roofing_siding_sheet_metal
+ - secretarial_support_services
+ - security_brokers_dealers
+ - service_stations
+ - sewing_needlework_fabric_and_piece_goods_stores
+ - shoe_repair_hat_cleaning
+ - shoe_stores
+ - small_appliance_repair
+ - snowmobile_dealers
+ - special_trade_services
+ - specialty_cleaning
+ - sporting_goods_stores
+ - sporting_recreation_camps
+ - sports_and_riding_apparel_stores
+ - sports_clubs_fields
+ - stamp_and_coin_stores
+ - stationary_office_supplies_printing_and_writing_paper
+ - stationery_stores_office_and_school_supply_stores
+ - swimming_pools_sales
+ - t_ui_travel_germany
+ - tailors_alterations
+ - tax_payments_government_agencies
+ - tax_preparation_services
+ - taxicabs_limousines
+ - telecommunication_equipment_and_telephone_sales
+ - telecommunication_services
+ - telegraph_services
+ - tent_and_awning_shops
+ - testing_laboratories
+ - theatrical_ticket_agencies
+ - timeshares
+ - tire_retreading_and_repair
+ - tolls_bridge_fees
+ - tourist_attractions_and_exhibits
+ - towing_services
+ - trailer_parks_campgrounds
+ - transportation_services
+ - travel_agencies_tour_operators
+ - truck_stop_iteration
+ - truck_utility_trailer_rentals
+ - typesetting_plate_making_and_related_services
+ - typewriter_stores
+ - u_s_federal_government_agencies_or_departments
+ - uniforms_commercial_clothing
+ - used_merchandise_and_secondhand_stores
+ - utilities
+ - variety_stores
+ - veterinary_services
+ - video_amusement_game_supplies
+ - video_game_arcades
+ - video_tape_rental_stores
+ - vocational_trade_schools
+ - watch_jewelry_repair
+ - welding_repair
+ - wholesale_clubs
+ - wig_and_toupee_stores
+ - wires_money_orders
+ - womens_accessory_and_specialty_shops
+ - womens_ready_to_wear_stores
+ - wrecking_and_salvage_yards
+ maxLength: 5000
+ type: string
+ city:
+ maxLength: 5000
+ type: string
+ country:
+ maxLength: 5000
+ type: string
+ name:
+ maxLength: 5000
+ type: string
+ network_id:
+ maxLength: 5000
+ type: string
+ postal_code:
+ maxLength: 5000
+ type: string
+ state:
+ maxLength: 5000
+ type: string
+ terminal_id:
+ maxLength: 5000
+ type: string
+ title: merchant_data_specs
+ type: object
+ network_data:
+ description: >-
+ Details about the authorization, such as identifiers, set by
+ the card network.
+ properties:
+ acquiring_institution_id:
+ maxLength: 5000
+ type: string
+ title: network_data_specs
+ type: object
+ verification_data:
+ description: >-
+ Verifications that Stripe performed on information that the
+ cardholder provided to the merchant.
+ properties:
+ address_line1_check:
+ enum:
+ - match
+ - mismatch
+ - not_provided
+ type: string
+ address_postal_code_check:
+ enum:
+ - match
+ - mismatch
+ - not_provided
+ type: string
+ cvc_check:
+ enum:
+ - match
+ - mismatch
+ - not_provided
+ type: string
+ expiry_check:
+ enum:
+ - match
+ - mismatch
+ - not_provided
+ type: string
+ title: verification_data_specs
+ type: object
+ wallet:
+ description: >-
+ The digital wallet used for this transaction. One of
+ `apple_pay`, `google_pay`, or `samsung_pay`. Will populate
+ as `null` when no digital wallet was utilized.
+ enum:
+ - apple_pay
+ - google_pay
+ - samsung_pay
+ type: string
+ required:
+ - amount
+ - card
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.authorization'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/authorizations/{authorization}/capture':
+ post:
+ description: Capture a test-mode authorization.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationCapture
parameters:
- in: path
- name: card
+ name: authorization
required: true
schema:
maxLength: 5000
@@ -102188,15 +103366,129 @@ paths:
expand:
explode: true
style: deepObject
+ purchase_details:
+ explode: true
+ style: deepObject
schema:
additionalProperties: false
properties:
+ capture_amount:
+ description: >-
+ The amount to capture from the authorization. If not
+ provided, the full amount of the authorization will be
+ captured. This amount is in the authorization currency and
+ in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ close_authorization:
+ description: >-
+ Whether to close the authorization after capture. Defaults
+ to true. Set to false to enable multi-capture flows.
+ type: boolean
expand:
description: Specifies which fields in the response should be expanded.
items:
maxLength: 5000
type: string
type: array
+ purchase_details:
+ description: >-
+ Additional purchase information that is optionally provided
+ by the merchant.
+ properties:
+ flight:
+ properties:
+ departure_at:
+ format: unix-time
+ type: integer
+ passenger_name:
+ maxLength: 5000
+ type: string
+ refundable:
+ type: boolean
+ segments:
+ items:
+ properties:
+ arrival_airport_code:
+ maxLength: 3
+ type: string
+ carrier:
+ maxLength: 5000
+ type: string
+ departure_airport_code:
+ maxLength: 3
+ type: string
+ flight_number:
+ maxLength: 5000
+ type: string
+ service_class:
+ maxLength: 5000
+ type: string
+ stopover_allowed:
+ type: boolean
+ title: flight_segment_specs
+ type: object
+ type: array
+ travel_agency:
+ maxLength: 5000
+ type: string
+ title: flight_specs
+ type: object
+ fuel:
+ properties:
+ type:
+ enum:
+ - diesel
+ - other
+ - unleaded_plus
+ - unleaded_regular
+ - unleaded_super
+ maxLength: 5000
+ type: string
+ unit:
+ enum:
+ - liter
+ - us_gallon
+ maxLength: 5000
+ type: string
+ unit_cost_decimal:
+ format: decimal
+ type: string
+ volume_decimal:
+ format: decimal
+ type: string
+ title: fuel_specs
+ type: object
+ lodging:
+ properties:
+ check_in_at:
+ format: unix-time
+ type: integer
+ nights:
+ type: integer
+ title: lodging_specs
+ type: object
+ receipt:
+ items:
+ properties:
+ description:
+ maxLength: 26
+ type: string
+ quantity:
+ format: decimal
+ type: string
+ total:
+ type: integer
+ unit_cost:
+ type: integer
+ title: receipt_specs
+ type: object
+ type: array
+ reference:
+ maxLength: 5000
+ type: string
+ title: purchase_details_specs
+ type: object
type: object
required: false
responses:
@@ -102204,7 +103496,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/issuing.card'
+ $ref: '#/components/schemas/issuing.authorization'
description: Successful response.
default:
content:
@@ -102212,15 +103504,13 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
- '/v1/test_helpers/issuing/cards/{card}/shipping/fail':
+ '/v1/test_helpers/issuing/authorizations/{authorization}/expire':
post:
- description: >-
- Updates the shipping status of the specified Issuing
- Card
object to failure
.
- operationId: PostTestHelpersIssuingCardsCardShippingFail
+ description: Expire a test-mode Authorization.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationExpire
parameters:
- in: path
- name: card
+ name: authorization
required: true
schema:
maxLength: 5000
@@ -102249,7 +103539,7 @@ paths:
content:
application/json:
schema:
- $ref: '#/components/schemas/issuing.card'
+ $ref: '#/components/schemas/issuing.authorization'
description: Successful response.
default:
content:
@@ -102257,12 +103547,210 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
- '/v1/test_helpers/issuing/cards/{card}/shipping/return':
+ '/v1/test_helpers/issuing/authorizations/{authorization}/increment':
+ post:
+ description: Increment a test-mode Authorization.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationIncrement
+ parameters:
+ - in: path
+ name: authorization
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ increment_amount:
+ description: >-
+ The amount to increment the authorization by. This amount is
+ in the authorization currency and in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ is_amount_controllable:
+ description: >-
+ If set `true`, you may provide
+ [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount)
+ to control how much to hold for the authorization.
+ type: boolean
+ required:
+ - increment_amount
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.authorization'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/authorizations/{authorization}/reverse':
+ post:
+ description: Reverse a test-mode Authorization.
+ operationId: PostTestHelpersIssuingAuthorizationsAuthorizationReverse
+ parameters:
+ - in: path
+ name: authorization
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ reverse_amount:
+ description: >-
+ The amount to reverse from the authorization. If not
+ provided, the full amount of the authorization will be
+ reversed. This amount is in the authorization currency and
+ in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.authorization'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/cards/{card}/shipping/deliver':
post:
description: >-
Updates the shipping status of the specified Issuing
- Card
object to returned
.
- operationId: PostTestHelpersIssuingCardsCardShippingReturn
+ Card
object to delivered
.
+ operationId: PostTestHelpersIssuingCardsCardShippingDeliver
+ parameters:
+ - in: path
+ name: card
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.card'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/cards/{card}/shipping/fail':
+ post:
+ description: >-
+ Updates the shipping status of the specified Issuing
+ Card
object to failure
.
+ operationId: PostTestHelpersIssuingCardsCardShippingFail
+ parameters:
+ - in: path
+ name: card
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.card'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/cards/{card}/shipping/return':
+ post:
+ description: >-
+ Updates the shipping status of the specified Issuing
+ Card
object to returned
.
+ operationId: PostTestHelpersIssuingCardsCardShippingReturn
parameters:
- in: path
name: card
@@ -102347,6 +103835,1049 @@ paths:
schema:
$ref: '#/components/schemas/error'
description: Error response.
+ /v1/test_helpers/issuing/transactions/create_force_capture:
+ post:
+ description: >-
+ Allows the user to capture an arbitrary amount, also known as a
+ forced capture.
+ operationId: PostTestHelpersIssuingTransactionsCreateForceCapture
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ merchant_data:
+ explode: true
+ style: deepObject
+ purchase_details:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ amount:
+ description: >-
+ The total amount to attempt to capture. This amount is in
+ the provided currency, or defaults to the cards currency,
+ and in the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ card:
+ description: Card associated with this transaction.
+ maxLength: 5000
+ type: string
+ currency:
+ description: >-
+ The currency of the capture. If not provided, defaults to
+ the currency of the card. Three-letter [ISO currency
+ code](https://www.iso.org/iso-4217-currency-codes.html), in
+ lowercase. Must be a [supported
+ currency](https://stripe.com/docs/currencies).
+ type: string
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ merchant_data:
+ description: >-
+ Details about the seller (grocery store, e-commerce website,
+ etc.) where the card authorization happened.
+ properties:
+ category:
+ enum:
+ - ac_refrigeration_repair
+ - accounting_bookkeeping_services
+ - advertising_services
+ - agricultural_cooperative
+ - airlines_air_carriers
+ - airports_flying_fields
+ - ambulance_services
+ - amusement_parks_carnivals
+ - antique_reproductions
+ - antique_shops
+ - aquariums
+ - architectural_surveying_services
+ - art_dealers_and_galleries
+ - artists_supply_and_craft_shops
+ - auto_and_home_supply_stores
+ - auto_body_repair_shops
+ - auto_paint_shops
+ - auto_service_shops
+ - automated_cash_disburse
+ - automated_fuel_dispensers
+ - automobile_associations
+ - automotive_parts_and_accessories_stores
+ - automotive_tire_stores
+ - bail_and_bond_payments
+ - bakeries
+ - bands_orchestras
+ - barber_and_beauty_shops
+ - betting_casino_gambling
+ - bicycle_shops
+ - billiard_pool_establishments
+ - boat_dealers
+ - boat_rentals_and_leases
+ - book_stores
+ - books_periodicals_and_newspapers
+ - bowling_alleys
+ - bus_lines
+ - business_secretarial_schools
+ - buying_shopping_services
+ - cable_satellite_and_other_pay_television_and_radio
+ - camera_and_photographic_supply_stores
+ - candy_nut_and_confectionery_stores
+ - car_and_truck_dealers_new_used
+ - car_and_truck_dealers_used_only
+ - car_rental_agencies
+ - car_washes
+ - carpentry_services
+ - carpet_upholstery_cleaning
+ - caterers
+ - >-
+ charitable_and_social_service_organizations_fundraising
+ - chemicals_and_allied_products
+ - child_care_services
+ - childrens_and_infants_wear_stores
+ - chiropodists_podiatrists
+ - chiropractors
+ - cigar_stores_and_stands
+ - civic_social_fraternal_associations
+ - cleaning_and_maintenance
+ - clothing_rental
+ - colleges_universities
+ - commercial_equipment
+ - commercial_footwear
+ - commercial_photography_art_and_graphics
+ - commuter_transport_and_ferries
+ - computer_network_services
+ - computer_programming
+ - computer_repair
+ - computer_software_stores
+ - computers_peripherals_and_software
+ - concrete_work_services
+ - construction_materials
+ - consulting_public_relations
+ - correspondence_schools
+ - cosmetic_stores
+ - counseling_services
+ - country_clubs
+ - courier_services
+ - court_costs
+ - credit_reporting_agencies
+ - cruise_lines
+ - dairy_products_stores
+ - dance_hall_studios_schools
+ - dating_escort_services
+ - dentists_orthodontists
+ - department_stores
+ - detective_agencies
+ - digital_goods_applications
+ - digital_goods_games
+ - digital_goods_large_volume
+ - digital_goods_media
+ - direct_marketing_catalog_merchant
+ - >-
+ direct_marketing_combination_catalog_and_retail_merchant
+ - direct_marketing_inbound_telemarketing
+ - direct_marketing_insurance_services
+ - direct_marketing_other
+ - direct_marketing_outbound_telemarketing
+ - direct_marketing_subscription
+ - direct_marketing_travel
+ - discount_stores
+ - doctors
+ - door_to_door_sales
+ - drapery_window_covering_and_upholstery_stores
+ - drinking_places
+ - drug_stores_and_pharmacies
+ - drugs_drug_proprietaries_and_druggist_sundries
+ - dry_cleaners
+ - durable_goods
+ - duty_free_stores
+ - eating_places_restaurants
+ - educational_services
+ - electric_razor_stores
+ - electric_vehicle_charging
+ - electrical_parts_and_equipment
+ - electrical_services
+ - electronics_repair_shops
+ - electronics_stores
+ - elementary_secondary_schools
+ - emergency_services_gcas_visa_use_only
+ - employment_temp_agencies
+ - equipment_rental
+ - exterminating_services
+ - family_clothing_stores
+ - fast_food_restaurants
+ - financial_institutions
+ - fines_government_administrative_entities
+ - fireplace_fireplace_screens_and_accessories_stores
+ - floor_covering_stores
+ - florists
+ - florists_supplies_nursery_stock_and_flowers
+ - freezer_and_locker_meat_provisioners
+ - fuel_dealers_non_automotive
+ - funeral_services_crematories
+ - >-
+ furniture_home_furnishings_and_equipment_stores_except_appliances
+ - furniture_repair_refinishing
+ - furriers_and_fur_shops
+ - general_services
+ - gift_card_novelty_and_souvenir_shops
+ - glass_paint_and_wallpaper_stores
+ - glassware_crystal_stores
+ - golf_courses_public
+ - government_licensed_horse_dog_racing_us_region_only
+ - >-
+ government_licensed_online_casions_online_gambling_us_region_only
+ - government_owned_lotteries_non_us_region
+ - government_owned_lotteries_us_region_only
+ - government_services
+ - grocery_stores_supermarkets
+ - hardware_equipment_and_supplies
+ - hardware_stores
+ - health_and_beauty_spas
+ - hearing_aids_sales_and_supplies
+ - heating_plumbing_a_c
+ - hobby_toy_and_game_shops
+ - home_supply_warehouse_stores
+ - hospitals
+ - hotels_motels_and_resorts
+ - household_appliance_stores
+ - industrial_supplies
+ - information_retrieval_services
+ - insurance_default
+ - insurance_underwriting_premiums
+ - intra_company_purchases
+ - jewelry_stores_watches_clocks_and_silverware_stores
+ - landscaping_services
+ - laundries
+ - laundry_cleaning_services
+ - legal_services_attorneys
+ - luggage_and_leather_goods_stores
+ - lumber_building_materials_stores
+ - manual_cash_disburse
+ - marinas_service_and_supplies
+ - marketplaces
+ - masonry_stonework_and_plaster
+ - massage_parlors
+ - medical_and_dental_labs
+ - >-
+ medical_dental_ophthalmic_and_hospital_equipment_and_supplies
+ - medical_services
+ - membership_organizations
+ - mens_and_boys_clothing_and_accessories_stores
+ - mens_womens_clothing_stores
+ - metal_service_centers
+ - miscellaneous_apparel_and_accessory_shops
+ - miscellaneous_auto_dealers
+ - miscellaneous_business_services
+ - miscellaneous_food_stores
+ - miscellaneous_general_merchandise
+ - miscellaneous_general_services
+ - miscellaneous_home_furnishing_specialty_stores
+ - miscellaneous_publishing_and_printing
+ - miscellaneous_recreation_services
+ - miscellaneous_repair_shops
+ - miscellaneous_specialty_retail
+ - mobile_home_dealers
+ - motion_picture_theaters
+ - motor_freight_carriers_and_trucking
+ - motor_homes_dealers
+ - motor_vehicle_supplies_and_new_parts
+ - motorcycle_shops_and_dealers
+ - motorcycle_shops_dealers
+ - >-
+ music_stores_musical_instruments_pianos_and_sheet_music
+ - news_dealers_and_newsstands
+ - non_fi_money_orders
+ - non_fi_stored_value_card_purchase_load
+ - nondurable_goods
+ - nurseries_lawn_and_garden_supply_stores
+ - nursing_personal_care
+ - office_and_commercial_furniture
+ - opticians_eyeglasses
+ - optometrists_ophthalmologist
+ - orthopedic_goods_prosthetic_devices
+ - osteopaths
+ - package_stores_beer_wine_and_liquor
+ - paints_varnishes_and_supplies
+ - parking_lots_garages
+ - passenger_railways
+ - pawn_shops
+ - pet_shops_pet_food_and_supplies
+ - petroleum_and_petroleum_products
+ - photo_developing
+ - >-
+ photographic_photocopy_microfilm_equipment_and_supplies
+ - photographic_studios
+ - picture_video_production
+ - piece_goods_notions_and_other_dry_goods
+ - plumbing_heating_equipment_and_supplies
+ - political_organizations
+ - postal_services_government_only
+ - precious_stones_and_metals_watches_and_jewelry
+ - professional_services
+ - public_warehousing_and_storage
+ - quick_copy_repro_and_blueprint
+ - railroads
+ - real_estate_agents_and_managers_rentals
+ - record_stores
+ - recreational_vehicle_rentals
+ - religious_goods_stores
+ - religious_organizations
+ - roofing_siding_sheet_metal
+ - secretarial_support_services
+ - security_brokers_dealers
+ - service_stations
+ - sewing_needlework_fabric_and_piece_goods_stores
+ - shoe_repair_hat_cleaning
+ - shoe_stores
+ - small_appliance_repair
+ - snowmobile_dealers
+ - special_trade_services
+ - specialty_cleaning
+ - sporting_goods_stores
+ - sporting_recreation_camps
+ - sports_and_riding_apparel_stores
+ - sports_clubs_fields
+ - stamp_and_coin_stores
+ - stationary_office_supplies_printing_and_writing_paper
+ - stationery_stores_office_and_school_supply_stores
+ - swimming_pools_sales
+ - t_ui_travel_germany
+ - tailors_alterations
+ - tax_payments_government_agencies
+ - tax_preparation_services
+ - taxicabs_limousines
+ - telecommunication_equipment_and_telephone_sales
+ - telecommunication_services
+ - telegraph_services
+ - tent_and_awning_shops
+ - testing_laboratories
+ - theatrical_ticket_agencies
+ - timeshares
+ - tire_retreading_and_repair
+ - tolls_bridge_fees
+ - tourist_attractions_and_exhibits
+ - towing_services
+ - trailer_parks_campgrounds
+ - transportation_services
+ - travel_agencies_tour_operators
+ - truck_stop_iteration
+ - truck_utility_trailer_rentals
+ - typesetting_plate_making_and_related_services
+ - typewriter_stores
+ - u_s_federal_government_agencies_or_departments
+ - uniforms_commercial_clothing
+ - used_merchandise_and_secondhand_stores
+ - utilities
+ - variety_stores
+ - veterinary_services
+ - video_amusement_game_supplies
+ - video_game_arcades
+ - video_tape_rental_stores
+ - vocational_trade_schools
+ - watch_jewelry_repair
+ - welding_repair
+ - wholesale_clubs
+ - wig_and_toupee_stores
+ - wires_money_orders
+ - womens_accessory_and_specialty_shops
+ - womens_ready_to_wear_stores
+ - wrecking_and_salvage_yards
+ maxLength: 5000
+ type: string
+ city:
+ maxLength: 5000
+ type: string
+ country:
+ maxLength: 5000
+ type: string
+ name:
+ maxLength: 5000
+ type: string
+ network_id:
+ maxLength: 5000
+ type: string
+ postal_code:
+ maxLength: 5000
+ type: string
+ state:
+ maxLength: 5000
+ type: string
+ terminal_id:
+ maxLength: 5000
+ type: string
+ title: merchant_data_specs
+ type: object
+ purchase_details:
+ description: >-
+ Additional purchase information that is optionally provided
+ by the merchant.
+ properties:
+ flight:
+ properties:
+ departure_at:
+ format: unix-time
+ type: integer
+ passenger_name:
+ maxLength: 5000
+ type: string
+ refundable:
+ type: boolean
+ segments:
+ items:
+ properties:
+ arrival_airport_code:
+ maxLength: 3
+ type: string
+ carrier:
+ maxLength: 5000
+ type: string
+ departure_airport_code:
+ maxLength: 3
+ type: string
+ flight_number:
+ maxLength: 5000
+ type: string
+ service_class:
+ maxLength: 5000
+ type: string
+ stopover_allowed:
+ type: boolean
+ title: flight_segment_specs
+ type: object
+ type: array
+ travel_agency:
+ maxLength: 5000
+ type: string
+ title: flight_specs
+ type: object
+ fuel:
+ properties:
+ type:
+ enum:
+ - diesel
+ - other
+ - unleaded_plus
+ - unleaded_regular
+ - unleaded_super
+ maxLength: 5000
+ type: string
+ unit:
+ enum:
+ - liter
+ - us_gallon
+ maxLength: 5000
+ type: string
+ unit_cost_decimal:
+ format: decimal
+ type: string
+ volume_decimal:
+ format: decimal
+ type: string
+ title: fuel_specs
+ type: object
+ lodging:
+ properties:
+ check_in_at:
+ format: unix-time
+ type: integer
+ nights:
+ type: integer
+ title: lodging_specs
+ type: object
+ receipt:
+ items:
+ properties:
+ description:
+ maxLength: 26
+ type: string
+ quantity:
+ format: decimal
+ type: string
+ total:
+ type: integer
+ unit_cost:
+ type: integer
+ title: receipt_specs
+ type: object
+ type: array
+ reference:
+ maxLength: 5000
+ type: string
+ title: purchase_details_specs
+ type: object
+ required:
+ - amount
+ - card
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.transaction'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ /v1/test_helpers/issuing/transactions/create_unlinked_refund:
+ post:
+ description: >-
+ Allows the user to refund an arbitrary amount, also known as a
+ unlinked refund.
+ operationId: PostTestHelpersIssuingTransactionsCreateUnlinkedRefund
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ merchant_data:
+ explode: true
+ style: deepObject
+ purchase_details:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ amount:
+ description: >-
+ The total amount to attempt to refund. This amount is in the
+ provided currency, or defaults to the cards currency, and in
+ the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ card:
+ description: Card associated with this unlinked refund transaction.
+ maxLength: 5000
+ type: string
+ currency:
+ description: >-
+ The currency of the unlinked refund. If not provided,
+ defaults to the currency of the card. Three-letter [ISO
+ currency
+ code](https://www.iso.org/iso-4217-currency-codes.html), in
+ lowercase. Must be a [supported
+ currency](https://stripe.com/docs/currencies).
+ type: string
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ merchant_data:
+ description: >-
+ Details about the seller (grocery store, e-commerce website,
+ etc.) where the card authorization happened.
+ properties:
+ category:
+ enum:
+ - ac_refrigeration_repair
+ - accounting_bookkeeping_services
+ - advertising_services
+ - agricultural_cooperative
+ - airlines_air_carriers
+ - airports_flying_fields
+ - ambulance_services
+ - amusement_parks_carnivals
+ - antique_reproductions
+ - antique_shops
+ - aquariums
+ - architectural_surveying_services
+ - art_dealers_and_galleries
+ - artists_supply_and_craft_shops
+ - auto_and_home_supply_stores
+ - auto_body_repair_shops
+ - auto_paint_shops
+ - auto_service_shops
+ - automated_cash_disburse
+ - automated_fuel_dispensers
+ - automobile_associations
+ - automotive_parts_and_accessories_stores
+ - automotive_tire_stores
+ - bail_and_bond_payments
+ - bakeries
+ - bands_orchestras
+ - barber_and_beauty_shops
+ - betting_casino_gambling
+ - bicycle_shops
+ - billiard_pool_establishments
+ - boat_dealers
+ - boat_rentals_and_leases
+ - book_stores
+ - books_periodicals_and_newspapers
+ - bowling_alleys
+ - bus_lines
+ - business_secretarial_schools
+ - buying_shopping_services
+ - cable_satellite_and_other_pay_television_and_radio
+ - camera_and_photographic_supply_stores
+ - candy_nut_and_confectionery_stores
+ - car_and_truck_dealers_new_used
+ - car_and_truck_dealers_used_only
+ - car_rental_agencies
+ - car_washes
+ - carpentry_services
+ - carpet_upholstery_cleaning
+ - caterers
+ - >-
+ charitable_and_social_service_organizations_fundraising
+ - chemicals_and_allied_products
+ - child_care_services
+ - childrens_and_infants_wear_stores
+ - chiropodists_podiatrists
+ - chiropractors
+ - cigar_stores_and_stands
+ - civic_social_fraternal_associations
+ - cleaning_and_maintenance
+ - clothing_rental
+ - colleges_universities
+ - commercial_equipment
+ - commercial_footwear
+ - commercial_photography_art_and_graphics
+ - commuter_transport_and_ferries
+ - computer_network_services
+ - computer_programming
+ - computer_repair
+ - computer_software_stores
+ - computers_peripherals_and_software
+ - concrete_work_services
+ - construction_materials
+ - consulting_public_relations
+ - correspondence_schools
+ - cosmetic_stores
+ - counseling_services
+ - country_clubs
+ - courier_services
+ - court_costs
+ - credit_reporting_agencies
+ - cruise_lines
+ - dairy_products_stores
+ - dance_hall_studios_schools
+ - dating_escort_services
+ - dentists_orthodontists
+ - department_stores
+ - detective_agencies
+ - digital_goods_applications
+ - digital_goods_games
+ - digital_goods_large_volume
+ - digital_goods_media
+ - direct_marketing_catalog_merchant
+ - >-
+ direct_marketing_combination_catalog_and_retail_merchant
+ - direct_marketing_inbound_telemarketing
+ - direct_marketing_insurance_services
+ - direct_marketing_other
+ - direct_marketing_outbound_telemarketing
+ - direct_marketing_subscription
+ - direct_marketing_travel
+ - discount_stores
+ - doctors
+ - door_to_door_sales
+ - drapery_window_covering_and_upholstery_stores
+ - drinking_places
+ - drug_stores_and_pharmacies
+ - drugs_drug_proprietaries_and_druggist_sundries
+ - dry_cleaners
+ - durable_goods
+ - duty_free_stores
+ - eating_places_restaurants
+ - educational_services
+ - electric_razor_stores
+ - electric_vehicle_charging
+ - electrical_parts_and_equipment
+ - electrical_services
+ - electronics_repair_shops
+ - electronics_stores
+ - elementary_secondary_schools
+ - emergency_services_gcas_visa_use_only
+ - employment_temp_agencies
+ - equipment_rental
+ - exterminating_services
+ - family_clothing_stores
+ - fast_food_restaurants
+ - financial_institutions
+ - fines_government_administrative_entities
+ - fireplace_fireplace_screens_and_accessories_stores
+ - floor_covering_stores
+ - florists
+ - florists_supplies_nursery_stock_and_flowers
+ - freezer_and_locker_meat_provisioners
+ - fuel_dealers_non_automotive
+ - funeral_services_crematories
+ - >-
+ furniture_home_furnishings_and_equipment_stores_except_appliances
+ - furniture_repair_refinishing
+ - furriers_and_fur_shops
+ - general_services
+ - gift_card_novelty_and_souvenir_shops
+ - glass_paint_and_wallpaper_stores
+ - glassware_crystal_stores
+ - golf_courses_public
+ - government_licensed_horse_dog_racing_us_region_only
+ - >-
+ government_licensed_online_casions_online_gambling_us_region_only
+ - government_owned_lotteries_non_us_region
+ - government_owned_lotteries_us_region_only
+ - government_services
+ - grocery_stores_supermarkets
+ - hardware_equipment_and_supplies
+ - hardware_stores
+ - health_and_beauty_spas
+ - hearing_aids_sales_and_supplies
+ - heating_plumbing_a_c
+ - hobby_toy_and_game_shops
+ - home_supply_warehouse_stores
+ - hospitals
+ - hotels_motels_and_resorts
+ - household_appliance_stores
+ - industrial_supplies
+ - information_retrieval_services
+ - insurance_default
+ - insurance_underwriting_premiums
+ - intra_company_purchases
+ - jewelry_stores_watches_clocks_and_silverware_stores
+ - landscaping_services
+ - laundries
+ - laundry_cleaning_services
+ - legal_services_attorneys
+ - luggage_and_leather_goods_stores
+ - lumber_building_materials_stores
+ - manual_cash_disburse
+ - marinas_service_and_supplies
+ - marketplaces
+ - masonry_stonework_and_plaster
+ - massage_parlors
+ - medical_and_dental_labs
+ - >-
+ medical_dental_ophthalmic_and_hospital_equipment_and_supplies
+ - medical_services
+ - membership_organizations
+ - mens_and_boys_clothing_and_accessories_stores
+ - mens_womens_clothing_stores
+ - metal_service_centers
+ - miscellaneous_apparel_and_accessory_shops
+ - miscellaneous_auto_dealers
+ - miscellaneous_business_services
+ - miscellaneous_food_stores
+ - miscellaneous_general_merchandise
+ - miscellaneous_general_services
+ - miscellaneous_home_furnishing_specialty_stores
+ - miscellaneous_publishing_and_printing
+ - miscellaneous_recreation_services
+ - miscellaneous_repair_shops
+ - miscellaneous_specialty_retail
+ - mobile_home_dealers
+ - motion_picture_theaters
+ - motor_freight_carriers_and_trucking
+ - motor_homes_dealers
+ - motor_vehicle_supplies_and_new_parts
+ - motorcycle_shops_and_dealers
+ - motorcycle_shops_dealers
+ - >-
+ music_stores_musical_instruments_pianos_and_sheet_music
+ - news_dealers_and_newsstands
+ - non_fi_money_orders
+ - non_fi_stored_value_card_purchase_load
+ - nondurable_goods
+ - nurseries_lawn_and_garden_supply_stores
+ - nursing_personal_care
+ - office_and_commercial_furniture
+ - opticians_eyeglasses
+ - optometrists_ophthalmologist
+ - orthopedic_goods_prosthetic_devices
+ - osteopaths
+ - package_stores_beer_wine_and_liquor
+ - paints_varnishes_and_supplies
+ - parking_lots_garages
+ - passenger_railways
+ - pawn_shops
+ - pet_shops_pet_food_and_supplies
+ - petroleum_and_petroleum_products
+ - photo_developing
+ - >-
+ photographic_photocopy_microfilm_equipment_and_supplies
+ - photographic_studios
+ - picture_video_production
+ - piece_goods_notions_and_other_dry_goods
+ - plumbing_heating_equipment_and_supplies
+ - political_organizations
+ - postal_services_government_only
+ - precious_stones_and_metals_watches_and_jewelry
+ - professional_services
+ - public_warehousing_and_storage
+ - quick_copy_repro_and_blueprint
+ - railroads
+ - real_estate_agents_and_managers_rentals
+ - record_stores
+ - recreational_vehicle_rentals
+ - religious_goods_stores
+ - religious_organizations
+ - roofing_siding_sheet_metal
+ - secretarial_support_services
+ - security_brokers_dealers
+ - service_stations
+ - sewing_needlework_fabric_and_piece_goods_stores
+ - shoe_repair_hat_cleaning
+ - shoe_stores
+ - small_appliance_repair
+ - snowmobile_dealers
+ - special_trade_services
+ - specialty_cleaning
+ - sporting_goods_stores
+ - sporting_recreation_camps
+ - sports_and_riding_apparel_stores
+ - sports_clubs_fields
+ - stamp_and_coin_stores
+ - stationary_office_supplies_printing_and_writing_paper
+ - stationery_stores_office_and_school_supply_stores
+ - swimming_pools_sales
+ - t_ui_travel_germany
+ - tailors_alterations
+ - tax_payments_government_agencies
+ - tax_preparation_services
+ - taxicabs_limousines
+ - telecommunication_equipment_and_telephone_sales
+ - telecommunication_services
+ - telegraph_services
+ - tent_and_awning_shops
+ - testing_laboratories
+ - theatrical_ticket_agencies
+ - timeshares
+ - tire_retreading_and_repair
+ - tolls_bridge_fees
+ - tourist_attractions_and_exhibits
+ - towing_services
+ - trailer_parks_campgrounds
+ - transportation_services
+ - travel_agencies_tour_operators
+ - truck_stop_iteration
+ - truck_utility_trailer_rentals
+ - typesetting_plate_making_and_related_services
+ - typewriter_stores
+ - u_s_federal_government_agencies_or_departments
+ - uniforms_commercial_clothing
+ - used_merchandise_and_secondhand_stores
+ - utilities
+ - variety_stores
+ - veterinary_services
+ - video_amusement_game_supplies
+ - video_game_arcades
+ - video_tape_rental_stores
+ - vocational_trade_schools
+ - watch_jewelry_repair
+ - welding_repair
+ - wholesale_clubs
+ - wig_and_toupee_stores
+ - wires_money_orders
+ - womens_accessory_and_specialty_shops
+ - womens_ready_to_wear_stores
+ - wrecking_and_salvage_yards
+ maxLength: 5000
+ type: string
+ city:
+ maxLength: 5000
+ type: string
+ country:
+ maxLength: 5000
+ type: string
+ name:
+ maxLength: 5000
+ type: string
+ network_id:
+ maxLength: 5000
+ type: string
+ postal_code:
+ maxLength: 5000
+ type: string
+ state:
+ maxLength: 5000
+ type: string
+ terminal_id:
+ maxLength: 5000
+ type: string
+ title: merchant_data_specs
+ type: object
+ purchase_details:
+ description: >-
+ Additional purchase information that is optionally provided
+ by the merchant.
+ properties:
+ flight:
+ properties:
+ departure_at:
+ format: unix-time
+ type: integer
+ passenger_name:
+ maxLength: 5000
+ type: string
+ refundable:
+ type: boolean
+ segments:
+ items:
+ properties:
+ arrival_airport_code:
+ maxLength: 3
+ type: string
+ carrier:
+ maxLength: 5000
+ type: string
+ departure_airport_code:
+ maxLength: 3
+ type: string
+ flight_number:
+ maxLength: 5000
+ type: string
+ service_class:
+ maxLength: 5000
+ type: string
+ stopover_allowed:
+ type: boolean
+ title: flight_segment_specs
+ type: object
+ type: array
+ travel_agency:
+ maxLength: 5000
+ type: string
+ title: flight_specs
+ type: object
+ fuel:
+ properties:
+ type:
+ enum:
+ - diesel
+ - other
+ - unleaded_plus
+ - unleaded_regular
+ - unleaded_super
+ maxLength: 5000
+ type: string
+ unit:
+ enum:
+ - liter
+ - us_gallon
+ maxLength: 5000
+ type: string
+ unit_cost_decimal:
+ format: decimal
+ type: string
+ volume_decimal:
+ format: decimal
+ type: string
+ title: fuel_specs
+ type: object
+ lodging:
+ properties:
+ check_in_at:
+ format: unix-time
+ type: integer
+ nights:
+ type: integer
+ title: lodging_specs
+ type: object
+ receipt:
+ items:
+ properties:
+ description:
+ maxLength: 26
+ type: string
+ quantity:
+ format: decimal
+ type: string
+ total:
+ type: integer
+ unit_cost:
+ type: integer
+ title: receipt_specs
+ type: object
+ type: array
+ reference:
+ maxLength: 5000
+ type: string
+ title: purchase_details_specs
+ type: object
+ required:
+ - amount
+ - card
+ type: object
+ required: true
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.transaction'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
+ '/v1/test_helpers/issuing/transactions/{transaction}/refund':
+ post:
+ description: Refund a test-mode Transaction.
+ operationId: PostTestHelpersIssuingTransactionsTransactionRefund
+ parameters:
+ - in: path
+ name: transaction
+ required: true
+ schema:
+ maxLength: 5000
+ type: string
+ style: simple
+ requestBody:
+ content:
+ application/x-www-form-urlencoded:
+ encoding:
+ expand:
+ explode: true
+ style: deepObject
+ schema:
+ additionalProperties: false
+ properties:
+ expand:
+ description: Specifies which fields in the response should be expanded.
+ items:
+ maxLength: 5000
+ type: string
+ type: array
+ refund_amount:
+ description: >-
+ The total amount to attempt to refund. This amount is in the
+ provided currency, or defaults to the cards currency, and in
+ the [smallest currency
+ unit](https://stripe.com/docs/currencies#zero-decimal).
+ type: integer
+ type: object
+ required: false
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/issuing.transaction'
+ description: Successful response.
+ default:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/error'
+ description: Error response.
'/v1/test_helpers/refunds/{refund}/expire':
post:
description: Expire a refund with a status of requires_action
.
@@ -108869,7 +111400,6 @@ paths:
- invoice.voided
- invoiceitem.created
- invoiceitem.deleted
- - invoiceitem.updated
- issuing_authorization.created
- issuing_authorization.request
- issuing_authorization.updated
@@ -109271,7 +111801,6 @@ paths:
- invoice.voided
- invoiceitem.created
- invoiceitem.deleted
- - invoiceitem.updated
- issuing_authorization.created
- issuing_authorization.request
- issuing_authorization.updated
diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts
index 273e5525e..83e14daed 100644
--- a/packages/openapi-typescript/src/transform/schema-object.ts
+++ b/packages/openapi-typescript/src/transform/schema-object.ts
@@ -159,11 +159,30 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
}
}
- // "type": "object" (explicit)
- // "anyOf" / "allOf" (object type implied)
-
// core type: properties + additionalProperties
const coreType: string[] = [];
+
+ // discriminators
+ for (const k of ["oneOf", "allOf", "anyOf"] as ("oneOf" | "allOf" | "anyOf")[]) {
+ if (!(schemaObject as any)[k]) continue;
+ const discriminatorRef: ReferenceObject | undefined = (schemaObject as any)[k].find((t: SchemaObject | ReferenceObject) => "$ref" in t && ctx.discriminators[t.$ref]);
+ if (discriminatorRef) {
+ const discriminator = ctx.discriminators[discriminatorRef.$ref];
+ // get the inferred propertyName value from the last section of the path (as the spec suggests to do)
+ let value = parseRef(path).path.pop()!;
+ // if mapping, and there’s a match, use this rather than the inferred name
+ if (discriminator.mapping) {
+ // Mapping value can either be a fully-qualified ref (#/components/schemas/XYZ) or a schema name (XYZ)
+ const matchedValue = Object.entries(discriminator.mapping).find(([, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value));
+ if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
+ }
+ coreType.unshift(indent(`${escObjKey(discriminator.propertyName)}: ${escStr(value)};`, indentLv + 1));
+ break;
+ }
+ }
+
+ // "type": "object" (explicit)
+ // "anyOf" / "allOf" (object type implied)
if (
("properties" in schemaObject && schemaObject.properties && Object.keys(schemaObject.properties).length) ||
("additionalProperties" in schemaObject && schemaObject.additionalProperties) ||
@@ -209,23 +228,6 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
indentLv--;
}
- // discriminators
- for (const k of ["oneOf", "allOf", "anyOf"] as ("oneOf" | "allOf" | "anyOf")[]) {
- if (!(schemaObject as any)[k]) continue;
- const discriminatorRef: ReferenceObject | undefined = (schemaObject as any)[k].find((t: SchemaObject | ReferenceObject) => "$ref" in t && ctx.discriminators[t.$ref]);
- if (discriminatorRef) {
- const discriminator = ctx.discriminators[discriminatorRef.$ref];
- let value = parseRef(path).path.pop()!;
- if (discriminator.mapping) {
- // Mapping value can either be a fully-qualified ref (#/components/schemas/XYZ) or a schema name (XYZ)
- const matchedValue = Object.entries(discriminator.mapping).find(([, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value));
- if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
- coreType.unshift(indent(`${escObjKey(discriminator.propertyName)}: ${escStr(value)};`, indentLv + 1));
- }
- break;
- }
- }
-
// close coreType
let finalType = coreType.length ? `{\n${coreType.join("\n")}\n${indent("}", indentLv)}` : "";
diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts
index 2bde2f09f..772194645 100644
--- a/packages/openapi-typescript/test/index.test.ts
+++ b/packages/openapi-typescript/test/index.test.ts
@@ -773,7 +773,9 @@ export interface components {
petType: "lizard";
};
Person: {
- pet: components["schemas"]["Pet"];
+ pet: {
+ petType: "Person";
+ } & components["schemas"]["Pet"];
};
};
responses: never;
@@ -787,6 +789,71 @@ export type $defs = Record;
export type external = Record;
+export type operations = Record;
+`);
+ });
+
+ test("discriminator with automatic propertyName generation", async () => {
+ const schema: OpenAPI3 = {
+ openapi: "3.1",
+ info: { title: "test", version: "1.0" },
+ components: {
+ schemas: {
+ Pet: {
+ required: ["_petType"],
+ type: "object",
+ properties: {
+ _petType: { type: "string" },
+ nickName: { type: "string", nullable: true },
+ },
+ additionalProperties: false,
+ discriminator: { propertyName: "_petType" },
+ },
+ Dog: {
+ type: "object",
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
+ properties: {
+ bark: { type: "boolean" },
+ },
+ },
+ Cat: {
+ type: "object",
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
+ },
+ },
+ },
+ };
+ const generated = await openapiTS(schema);
+ expect(generated).toBe(`${BOILERPLATE}
+export type paths = Record;
+
+export type webhooks = Record;
+
+export interface components {
+ schemas: {
+ Pet: {
+ _petType: string;
+ nickName?: string | null;
+ };
+ Dog: {
+ _petType: "Dog";
+ bark?: boolean;
+ } & components["schemas"]["Pet"];
+ Cat: {
+ _petType: "Cat";
+ } & components["schemas"]["Pet"];
+ };
+ responses: never;
+ parameters: never;
+ requestBodies: never;
+ headers: never;
+ pathItems: never;
+}
+
+export type $defs = Record;
+
+export type external = Record;
+
export type operations = Record;
`);
});
diff --git a/packages/openapi-typescript/test/schema-object.test.ts b/packages/openapi-typescript/test/schema-object.test.ts
index a9cc89b38..e7474b6de 100644
--- a/packages/openapi-typescript/test/schema-object.test.ts
+++ b/packages/openapi-typescript/test/schema-object.test.ts
@@ -581,13 +581,13 @@ describe("Schema Object", () => {
ctx: {
...options.ctx,
discriminators: {
- 'components["schemas"]["parent"]': {
- propertyName: "operation",
- },
+ 'components["schemas"]["parent"]': { propertyName: "operation" },
},
},
});
- expect(generated).toBe(`components["schemas"]["parent"] | null`);
+ expect(generated).toBe(`{
+ operation: "schema-object";
+} & (components["schemas"]["parent"] | null)`);
});
test("discriminator escape", () => {
@@ -615,6 +615,30 @@ describe("Schema Object", () => {
string?: string;
}`);
});
+
+ test("discriminator with automatic propertyName", () => {
+ const schema: SchemaObject = {
+ type: "object",
+ allOf: [{ $ref: 'components["schemas"]["Pet"]' }],
+ properties: {
+ bark: { type: "boolean" },
+ },
+ additionalProperties: false,
+ };
+ const generated = transformSchemaObject(schema, {
+ path: "#/components/schemas/Dog",
+ ctx: {
+ ...options.ctx,
+ discriminators: {
+ 'components["schemas"]["Pet"]': { propertyName: "_petType" },
+ },
+ },
+ });
+ expect(generated).toBe(`{
+ _petType: "Dog";
+ bark?: boolean;
+} & components["schemas"]["Pet"]`);
+ });
});
describe("allOf", () => {
From 19d5088d466e0f585be8fc6e2709ed0d10cea1a7 Mon Sep 17 00:00:00 2001
From: Drew Powers
Date: Wed, 13 Sep 2023 10:56:13 -0600
Subject: [PATCH 2/3] Update docs
---
docs/src/content/docs/advanced.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/docs/src/content/docs/advanced.md b/docs/src/content/docs/advanced.md
index 0b1db8336..0896e461e 100644
--- a/docs/src/content/docs/advanced.md
+++ b/docs/src/content/docs/advanced.md
@@ -488,4 +488,6 @@ Pet: components["schemas"]["Cat"] | components["schemas"]["Dog"] | components["s
Cat: { type?: "cat"; } & components["schemas"]["PetCommonProperties"];
```
+_Note: you optionally could provide `discriminator.propertyName: "type"` on `Pet` ([docs](https://spec.openapis.org/oas/v3.1.0#discriminator-object)) to automatically generate the `type` key, but is less explicit._
+
While the schema permits you to use composition in any way you like, it’s good to always take a look at the generated types and see if there’s a simpler way to express your unions & intersections. Limiting the use of `oneOf` is not the only way to do that, but often yields the greatest benefits.
From 81699536456c7a20eafb2a43ee7f3f0fa57a201f Mon Sep 17 00:00:00 2001
From: Drew Powers
Date: Wed, 13 Sep 2023 11:43:08 -0600
Subject: [PATCH 3/3] Improve tests, fix additional bugs
---
packages/openapi-typescript/src/load.ts | 16 +-
.../src/transform/schema-object.ts | 45 +++--
packages/openapi-typescript/src/types.ts | 2 +
.../openapi-typescript/test/index.test.ts | 187 ++++--------------
.../test/schema-object.test.ts | 30 ++-
5 files changed, 117 insertions(+), 163 deletions(-)
diff --git a/packages/openapi-typescript/src/load.ts b/packages/openapi-typescript/src/load.ts
index 7e255c920..4091dd6a7 100644
--- a/packages/openapi-typescript/src/load.ts
+++ b/packages/openapi-typescript/src/load.ts
@@ -1,4 +1,4 @@
-import type { ComponentsObject, Fetch, GlobalContext, OpenAPI3, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, SchemaObject, Subschema } from "./types.js";
+import type { ComponentsObject, DiscriminatorObject, Fetch, GlobalContext, OpenAPI3, OperationObject, ParameterObject, PathItemObject, ReferenceObject, RequestBodyObject, ResponseObject, SchemaObject, Subschema } from "./types.js";
import fs from "node:fs";
import path from "node:path";
import { Readable } from "node:stream";
@@ -296,7 +296,19 @@ export default async function load(schema: URL | Subschema | Readable, options:
walk(options.schemas[k].schema, (rawNode, nodePath) => {
const node = rawNode as unknown as SchemaObject;
if (!node.discriminator) return;
- options.discriminators[schemaID === "." ? makeTSIndex(nodePath) : makeTSIndex(["external", k, ...nodePath])] = node.discriminator;
+ const discriminator: DiscriminatorObject = { ...node.discriminator };
+
+ // handle child oneOf types (mapping isn’t explicit from children)
+ const oneOf: string[] = [];
+ if (Array.isArray(node.oneOf)) {
+ for (const child of node.oneOf) {
+ if (!child || typeof child !== "object" || !("$ref" in child)) continue;
+ oneOf.push(child.$ref);
+ }
+ }
+ if (oneOf.length) discriminator.oneOf = oneOf;
+
+ options.discriminators[schemaID === "." ? makeTSIndex(nodePath) : makeTSIndex(["external", k, ...nodePath])] = discriminator;
});
}
}
diff --git a/packages/openapi-typescript/src/transform/schema-object.ts b/packages/openapi-typescript/src/transform/schema-object.ts
index 83e14daed..70fe38b86 100644
--- a/packages/openapi-typescript/src/transform/schema-object.ts
+++ b/packages/openapi-typescript/src/transform/schema-object.ts
@@ -1,4 +1,4 @@
-import type { GlobalContext, ReferenceObject, SchemaObject } from "../types.js";
+import type { DiscriminatorObject, GlobalContext, ReferenceObject, SchemaObject } from "../types.js";
import { escObjKey, escStr, getEntries, getSchemaObjectComment, indent, parseRef, tsArrayOf, tsIntersectionOf, tsOmit, tsOneOf, tsOptionalProperty, tsReadonly, tsTupleOf, tsUnionOf, tsWithRequired } from "../utils.js";
import transformSchemaObjectMap from "./schema-object-map.js";
@@ -162,21 +162,24 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
// core type: properties + additionalProperties
const coreType: string[] = [];
- // discriminators
+ // discriminators: explicit mapping on schema object
for (const k of ["oneOf", "allOf", "anyOf"] as ("oneOf" | "allOf" | "anyOf")[]) {
if (!(schemaObject as any)[k]) continue;
- const discriminatorRef: ReferenceObject | undefined = (schemaObject as any)[k].find((t: SchemaObject | ReferenceObject) => "$ref" in t && ctx.discriminators[t.$ref]);
- if (discriminatorRef) {
- const discriminator = ctx.discriminators[discriminatorRef.$ref];
- // get the inferred propertyName value from the last section of the path (as the spec suggests to do)
- let value = parseRef(path).path.pop()!;
- // if mapping, and there’s a match, use this rather than the inferred name
- if (discriminator.mapping) {
- // Mapping value can either be a fully-qualified ref (#/components/schemas/XYZ) or a schema name (XYZ)
- const matchedValue = Object.entries(discriminator.mapping).find(([, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value));
- if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
- }
- coreType.unshift(indent(`${escObjKey(discriminator.propertyName)}: ${escStr(value)};`, indentLv + 1));
+ const discriminatorRef: ReferenceObject | undefined = (schemaObject as any)[k].find(
+ (t: SchemaObject | ReferenceObject) =>
+ "$ref" in t &&
+ (ctx.discriminators[t.$ref] || // explicit allOf from this node
+ Object.values(ctx.discriminators).find((d) => d.oneOf?.includes(path))), // implicit oneOf from parent
+ );
+ if (discriminatorRef && ctx.discriminators[discriminatorRef.$ref]) {
+ coreType.unshift(indent(getDiscriminatorPropertyName(path, ctx.discriminators[discriminatorRef.$ref]), indentLv + 1));
+ break;
+ }
+ }
+ // discriminators: implicit mapping from parent
+ for (const d of Object.values(ctx.discriminators)) {
+ if (d.oneOf?.includes(path)) {
+ coreType.unshift(indent(getDiscriminatorPropertyName(path, d), indentLv + 1));
break;
}
}
@@ -236,7 +239,7 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
const output: string[] = [];
for (const item of items) {
const itemType = transformSchemaObject(item, { path, ctx: { ...ctx, indentLv } });
- if ("$ref" in item && ctx.discriminators[item.$ref]?.mapping) {
+ if ("$ref" in item && ctx.discriminators[item.$ref]) {
output.push(tsOmit(itemType, [ctx.discriminators[item.$ref].propertyName]));
continue;
}
@@ -274,3 +277,15 @@ export function defaultSchemaObjectTransform(schemaObject: SchemaObject | Refere
// if no type could be generated, fall back to “empty object” type
return ctx.emptyObjectsUnknown ? "Record" : "Record";
}
+
+export function getDiscriminatorPropertyName(path: string, discriminator: DiscriminatorObject): string {
+ // get the inferred propertyName value from the last section of the path (as the spec suggests to do)
+ let value = parseRef(path).path.pop()!;
+ // if mapping, and there’s a match, use this rather than the inferred name
+ if (discriminator.mapping) {
+ // Mapping value can either be a fully-qualified ref (#/components/schemas/XYZ) or a schema name (XYZ)
+ const matchedValue = Object.entries(discriminator.mapping).find(([, v]) => (!v.startsWith("#") && v === value) || (v.startsWith("#") && parseRef(v).path.pop() === value));
+ if (matchedValue) value = matchedValue[0]; // why was this designed backwards!?
+ }
+ return `${escObjKey(discriminator.propertyName)}: ${escStr(value)};`;
+}
diff --git a/packages/openapi-typescript/src/types.ts b/packages/openapi-typescript/src/types.ts
index 7656145df..87ce34f6c 100644
--- a/packages/openapi-typescript/src/types.ts
+++ b/packages/openapi-typescript/src/types.ts
@@ -508,6 +508,8 @@ export interface DiscriminatorObject {
propertyName: string;
/** An object to hold mappings between payload values and schema names or references. */
mapping?: Record;
+ /** If this exists, then a discriminator type should be added to objects matching this path */
+ oneOf?: string[];
}
/**
diff --git a/packages/openapi-typescript/test/index.test.ts b/packages/openapi-typescript/test/index.test.ts
index 772194645..dc1254a14 100644
--- a/packages/openapi-typescript/test/index.test.ts
+++ b/packages/openapi-typescript/test/index.test.ts
@@ -530,7 +530,7 @@ export type operations = Record;
});
describe("3.1", () => {
- test("discriminator (allOf)", async () => {
+ test("discriminator + allOf", async () => {
const schema: OpenAPI3 = {
openapi: "3.1",
info: { title: "test", version: "1.0" },
@@ -542,17 +542,13 @@ export type operations = Record;
properties: { petType: { type: "string" } },
discriminator: {
propertyName: "petType",
- mapping: { dog: "Dog" },
+ mapping: {
+ dog: "Dog",
+ },
},
},
Cat: {
- allOf: [
- { $ref: "#/components/schemas/Pet" },
- {
- type: "object",
- properties: { name: { type: "string" } },
- },
- ],
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
},
Dog: {
allOf: [
@@ -564,13 +560,12 @@ export type operations = Record;
],
},
Lizard: {
- allOf: [
- { $ref: "#/components/schemas/Pet" },
- {
- type: "object",
- properties: { lovesRocks: { type: "boolean" } },
- },
- ],
+ // mix of object + allOf
+ type: "object",
+ properties: {
+ lovesRocks: { type: "boolean" },
+ },
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
},
},
},
@@ -588,9 +583,7 @@ export interface components {
};
Cat: {
petType: "Cat";
- } & Omit & {
- name?: string;
- };
+ } & Omit;
Dog: {
petType: "dog";
} & Omit & {
@@ -598,9 +591,8 @@ export interface components {
};
Lizard: {
petType: "Lizard";
- } & Omit & {
lovesRocks?: boolean;
- };
+ } & Omit;
};
responses: never;
parameters: never;
@@ -617,47 +609,38 @@ export type operations = Record;
`);
});
- test("discriminator with explicit mapping (oneOf)", async () => {
+ test("discriminator + allOf (no mapping)", async () => {
const schema: OpenAPI3 = {
openapi: "3.1",
info: { title: "test", version: "1.0" },
components: {
schemas: {
Pet: {
- type: "object", // note: this is “wrong” but added because this should be ignored (fixes a bug)
- oneOf: [{ $ref: "#/components/schemas/Cat" }, { $ref: "#/components/schemas/Dog" }, { $ref: "#/components/schemas/Lizard" }],
+ type: "object",
+ required: ["petType"],
+ properties: { petType: { type: "string" } },
discriminator: {
propertyName: "petType",
- mapping: {
- cat: "#/components/schemas/Cat",
- dog: "#/components/schemas/Dog",
- lizard: "#/components/schemas/Lizard",
- },
},
- } as any,
+ },
Cat: {
- type: "object",
- properties: {
- name: { type: "string" },
- petType: { type: "string", enum: ["cat"] },
- },
- required: ["petType"],
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
},
Dog: {
- type: "object",
- properties: {
- bark: { type: "string" },
- petType: { type: "string", enum: ["dog"] },
- },
- required: ["petType"],
+ allOf: [
+ { $ref: "#/components/schemas/Pet" },
+ {
+ type: "object",
+ properties: { bark: { type: "string" } },
+ },
+ ],
},
Lizard: {
type: "object",
properties: {
lovesRocks: { type: "boolean" },
- petType: { type: "string", enum: ["lizard"] },
},
- required: ["petType"],
+ allOf: [{ $ref: "#/components/schemas/Pet" }],
},
},
},
@@ -670,22 +653,21 @@ export type webhooks = Record;
export interface components {
schemas: {
- Pet: components["schemas"]["Cat"] | components["schemas"]["Dog"] | components["schemas"]["Lizard"];
- Cat: {
- name?: string;
- /** @enum {string} */
- petType: "cat";
+ Pet: {
+ petType: string;
};
+ Cat: {
+ petType: "Cat";
+ } & Omit;
Dog: {
+ petType: "Dog";
+ } & Omit & {
bark?: string;
- /** @enum {string} */
- petType: "dog";
};
Lizard: {
+ petType: "Lizard";
lovesRocks?: boolean;
- /** @enum {string} */
- petType: "lizard";
- };
+ } & Omit;
};
responses: never;
parameters: never;
@@ -702,49 +684,42 @@ export type operations = Record;
`);
});
- test("discriminator with implicit mapping (oneOf)", async () => {
+ test("discriminator + oneOf", async () => {
const schema: OpenAPI3 = {
openapi: "3.1",
info: { title: "test", version: "1.0" },
components: {
schemas: {
Pet: {
+ type: "object", // note: this is “wrong” but added because this should be ignored (fixes a bug)
+ required: ["petType"],
oneOf: [{ $ref: "#/components/schemas/Cat" }, { $ref: "#/components/schemas/Dog" }, { $ref: "#/components/schemas/Lizard" }],
discriminator: {
propertyName: "petType",
+ mapping: {
+ dog: "#/components/schemas/Dog",
+ },
},
} as any,
Cat: {
type: "object",
properties: {
name: { type: "string" },
- petType: { type: "string", enum: ["cat"] },
},
required: ["petType"],
},
Dog: {
type: "object",
- properties: {
- bark: { type: "string" },
- petType: { type: "string", enum: ["dog"] },
- },
+ properties: { bark: { type: "string" } },
required: ["petType"],
},
Lizard: {
type: "object",
properties: {
lovesRocks: { type: "boolean" },
- petType: { type: "string", enum: ["lizard"] },
},
required: ["petType"],
},
- Person: {
- type: "object",
- required: ["pet"],
- properties: {
- pet: { oneOf: [{ $ref: "#/components/schemas/Pet" }] },
- },
- },
},
},
};
@@ -759,89 +734,13 @@ export interface components {
Pet: components["schemas"]["Cat"] | components["schemas"]["Dog"] | components["schemas"]["Lizard"];
Cat: {
name?: string;
- /** @enum {string} */
- petType: "cat";
};
Dog: {
bark?: string;
- /** @enum {string} */
- petType: "dog";
};
Lizard: {
lovesRocks?: boolean;
- /** @enum {string} */
- petType: "lizard";
- };
- Person: {
- pet: {
- petType: "Person";
- } & components["schemas"]["Pet"];
- };
- };
- responses: never;
- parameters: never;
- requestBodies: never;
- headers: never;
- pathItems: never;
-}
-
-export type $defs = Record;
-
-export type external = Record;
-
-export type operations = Record;
-`);
- });
-
- test("discriminator with automatic propertyName generation", async () => {
- const schema: OpenAPI3 = {
- openapi: "3.1",
- info: { title: "test", version: "1.0" },
- components: {
- schemas: {
- Pet: {
- required: ["_petType"],
- type: "object",
- properties: {
- _petType: { type: "string" },
- nickName: { type: "string", nullable: true },
- },
- additionalProperties: false,
- discriminator: { propertyName: "_petType" },
- },
- Dog: {
- type: "object",
- allOf: [{ $ref: "#/components/schemas/Pet" }],
- properties: {
- bark: { type: "boolean" },
- },
- },
- Cat: {
- type: "object",
- allOf: [{ $ref: "#/components/schemas/Pet" }],
- },
- },
- },
- };
- const generated = await openapiTS(schema);
- expect(generated).toBe(`${BOILERPLATE}
-export type paths = Record;
-
-export type webhooks = Record;
-
-export interface components {
- schemas: {
- Pet: {
- _petType: string;
- nickName?: string | null;
};
- Dog: {
- _petType: "Dog";
- bark?: boolean;
- } & components["schemas"]["Pet"];
- Cat: {
- _petType: "Cat";
- } & components["schemas"]["Pet"];
};
responses: never;
parameters: never;
diff --git a/packages/openapi-typescript/test/schema-object.test.ts b/packages/openapi-typescript/test/schema-object.test.ts
index e7474b6de..0d60e5014 100644
--- a/packages/openapi-typescript/test/schema-object.test.ts
+++ b/packages/openapi-typescript/test/schema-object.test.ts
@@ -572,6 +572,32 @@ describe("Schema Object", () => {
}`);
});
+ test("discriminator (oneOf)", () => {
+ const schema: SchemaObject = {
+ type: "object",
+ required: ["name"],
+ properties: {
+ name: { type: "string" },
+ },
+ };
+ const generated = transformSchemaObject(schema, {
+ path: "#/components/schemas/Cat",
+ ctx: {
+ ...options.ctx,
+ discriminators: {
+ 'components["schemas"]["Pet"]': {
+ propertyName: "petType",
+ oneOf: ["#/components/schemas/Cat"],
+ },
+ },
+ },
+ });
+ expect(generated).toBe(`{
+ petType: "Cat";
+ name: string;
+}`);
+ });
+
test("discriminator without mapping and oneOf and null", () => {
const schema: SchemaObject = {
oneOf: [{ $ref: 'components["schemas"]["parent"]' }, { type: "null" }],
@@ -587,7 +613,7 @@ describe("Schema Object", () => {
});
expect(generated).toBe(`{
operation: "schema-object";
-} & (components["schemas"]["parent"] | null)`);
+} & (Omit | null)`);
});
test("discriminator escape", () => {
@@ -637,7 +663,7 @@ describe("Schema Object", () => {
expect(generated).toBe(`{
_petType: "Dog";
bark?: boolean;
-} & components["schemas"]["Pet"]`);
+} & Omit`);
});
});