;
+ };
+ /**
+ * Format: date-time
+ * @description The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ "nullable-alert-updated-at": string | null;
+ /**
+ * @description Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.
+ * @enum {string}
+ */
+ "secret-scanning-alert-state": "open" | "resolved";
+ /**
+ * @description **Required when the `state` is `resolved`.** The reason for resolving the alert.
+ * @enum {string|null}
+ */
+ "secret-scanning-alert-resolution": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | null;
+ /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */
+ "secret-scanning-location-commit": {
+ /**
+ * @description The file path in the repository
+ * @example /example/secrets.txt
+ */
+ path: string;
+ /** @description Line number at which the secret starts in the file */
+ start_line: number;
+ /** @description Line number at which the secret ends in the file */
+ end_line: number;
+ /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */
+ start_column: number;
+ /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */
+ end_column: number;
+ /**
+ * @description SHA-1 hash ID of the associated blob
+ * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
+ */
+ blob_sha: string;
+ /** @description The API URL to get the associated blob resource */
+ blob_url: string;
+ /**
+ * @description SHA-1 hash ID of the associated commit
+ * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
+ */
+ commit_sha: string;
+ /** @description The API URL to get the associated commit resource */
+ commit_url: string;
+ };
+ /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */
+ "secret-scanning-location-wiki-commit": {
+ /**
+ * @description The file path of the wiki page
+ * @example /example/Home.md
+ */
+ path: string;
+ /** @description Line number at which the secret starts in the file */
+ start_line: number;
+ /** @description Line number at which the secret ends in the file */
+ end_line: number;
+ /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */
+ start_column: number;
+ /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */
+ end_column: number;
+ /**
+ * @description SHA-1 hash ID of the associated blob
+ * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
+ */
+ blob_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki page
+ * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ page_url: string;
+ /**
+ * @description SHA-1 hash ID of the associated commit
+ * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ commit_sha: string;
+ /**
+ * @description The GitHub URL to get the associated wiki commit
+ * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5
+ */
+ commit_url: string;
+ };
+ /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */
+ "secret-scanning-location-issue-title": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_title_url: string;
+ };
+ /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */
+ "secret-scanning-location-issue-body": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
+ */
+ issue_body_url: string;
+ };
+ /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */
+ "secret-scanning-location-issue-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the issue comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ issue_comment_url: string;
+ };
+ /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */
+ "secret-scanning-location-discussion-title": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082
+ */
+ discussion_title_url: string;
+ };
+ /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */
+ "secret-scanning-location-discussion-body": {
+ /**
+ * Format: uri
+ * @description The URL to the discussion where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussion-4566270
+ */
+ discussion_body_url: string;
+ };
+ /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */
+ "secret-scanning-location-discussion-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the discussion comment where the secret was detected.
+ * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232
+ */
+ discussion_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */
+ "secret-scanning-location-pull-request-title": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846
+ */
+ pull_request_title_url: string;
+ };
+ /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */
+ "secret-scanning-location-pull-request-body": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846
+ */
+ pull_request_body_url: string;
+ };
+ /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */
+ "secret-scanning-location-pull-request-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
+ */
+ pull_request_comment_url: string;
+ };
+ /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */
+ "secret-scanning-location-pull-request-review": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
+ */
+ pull_request_review_url: string;
+ };
+ /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */
+ "secret-scanning-location-pull-request-review-comment": {
+ /**
+ * Format: uri
+ * @description The API URL to get the pull request review comment where the secret was detected.
+ * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
+ */
+ pull_request_review_comment_url: string;
+ };
+ /** @description Details on the location where the token was initially detected. This can be a commit, wiki commit, issue, discussion, pull request. */
+ "nullable-secret-scanning-first-detected-location": (components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]) | null;
+ "organization-secret-scanning-alert": {
+ number?: components["schemas"]["alert-number"];
+ created_at?: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ url?: components["schemas"]["alert-url"];
+ html_url?: components["schemas"]["alert-html-url"];
+ /**
+ * Format: uri
+ * @description The REST API URL of the code locations for this alert.
+ */
+ locations_url?: string;
+ state?: components["schemas"]["secret-scanning-alert-state"];
+ resolution?: components["schemas"]["secret-scanning-alert-resolution"];
+ /**
+ * Format: date-time
+ * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ resolved_at?: string | null;
+ resolved_by?: components["schemas"]["nullable-simple-user"];
+ /** @description The type of secret that secret scanning detected. */
+ secret_type?: string;
+ /**
+ * @description User-friendly name for the detected secret, matching the `secret_type`.
+ * For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
+ */
+ secret_type_display_name?: string;
+ /** @description The secret that was detected. */
+ secret?: string;
+ repository?: components["schemas"]["simple-repository"];
+ /** @description Whether push protection was bypassed for the detected secret. */
+ push_protection_bypassed?: boolean | null;
+ push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ push_protection_bypassed_at?: string | null;
+ push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"];
+ /** @description An optional comment when reviewing a push protection bypass. */
+ push_protection_bypass_request_reviewer_comment?: string | null;
+ /** @description An optional comment when requesting a push protection bypass. */
+ push_protection_bypass_request_comment?: string | null;
+ /**
+ * Format: uri
+ * @description The URL to a push protection bypass request.
+ */
+ push_protection_bypass_request_html_url?: string | null;
+ /** @description The comment that was optionally added when this alert was closed */
+ resolution_comment?: string | null;
+ /**
+ * @description The token status as of the latest validity check.
+ * @enum {string}
+ */
+ validity?: "active" | "inactive" | "unknown";
+ /** @description Whether the secret was publicly leaked. */
+ publicly_leaked?: boolean | null;
+ /** @description Whether the detected secret was found in multiple repositories in the same organization or enterprise. */
+ multi_repo?: boolean | null;
+ /** @description A boolean value representing whether or not alert is base64 encoded */
+ is_base64_encoded?: boolean | null;
+ first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"];
+ /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */
+ has_more_locations?: boolean;
+ assigned_to?: components["schemas"]["nullable-simple-user"];
+ };
+ /** @description The version of the entity. This is used to confirm you're updating the current version of the entity and mitigate unintentionally overriding someone else's update. */
+ "secret-scanning-row-version": string | null;
+ "secret-scanning-pattern-override": {
+ /** @description The ID of the pattern. */
+ token_type?: string;
+ /** @description The version of this pattern if it's a custom pattern. */
+ custom_pattern_version?: string | null;
+ /** @description The slug of the pattern. */
+ slug?: string;
+ /** @description The user-friendly name for the pattern. */
+ display_name?: string;
+ /** @description The total number of alerts generated by this pattern. */
+ alert_total?: number;
+ /** @description The percentage of all alerts that this pattern represents, rounded to the nearest integer. */
+ alert_total_percentage?: number;
+ /** @description The number of false positive alerts generated by this pattern. */
+ false_positives?: number;
+ /** @description The percentage of alerts from this pattern that are false positives, rounded to the nearest integer. */
+ false_positive_rate?: number;
+ /** @description The percentage of blocks for this pattern that were bypassed, rounded to the nearest integer. */
+ bypass_rate?: number;
+ /**
+ * @description The default push protection setting for this pattern.
+ * @enum {string}
+ */
+ default_setting?: "disabled" | "enabled";
+ /**
+ * @description The push protection setting for this pattern set at the enterprise level. Only present for partner patterns when the organization has a parent enterprise.
+ * @enum {string|null}
+ */
+ enterprise_setting?: "not-set" | "disabled" | "enabled" | null;
+ /**
+ * @description The current push protection setting for this pattern. If this is `not-set`, then it inherits either the enterprise setting if it exists or the default setting.
+ * @enum {string}
+ */
+ setting?: "not-set" | "disabled" | "enabled";
+ };
+ /**
+ * Secret scanning pattern configuration
+ * @description A collection of secret scanning patterns and their settings related to push protection.
+ */
+ "secret-scanning-pattern-configuration": {
+ pattern_config_version?: components["schemas"]["secret-scanning-row-version"];
+ /** @description Overrides for partner patterns. */
+ provider_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][];
+ /** @description Overrides for custom patterns defined by the organization. */
+ custom_pattern_overrides?: components["schemas"]["secret-scanning-pattern-override"][];
+ };
/** @description A product affected by the vulnerability detailed in a repository security advisory. */
- readonly "repository-advisory-vulnerability": {
+ "repository-advisory-vulnerability": {
/** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
/** @description The unique package name within its ecosystem. */
- readonly name: string | null;
+ name: string | null;
} | null;
/** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range: string | null;
+ vulnerable_version_range: string | null;
/** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions: string | null;
+ patched_versions: string | null;
/** @description The functions in the package that are affected. */
- readonly vulnerable_functions: readonly string[] | null;
+ vulnerable_functions: string[] | null;
};
/** @description A credit given to a user for a repository security advisory. */
- readonly "repository-advisory-credit": {
- readonly user: components["schemas"]["simple-user"];
- readonly type: components["schemas"]["security-advisory-credit-types"];
+ "repository-advisory-credit": {
+ user: components["schemas"]["simple-user"];
+ type: components["schemas"]["security-advisory-credit-types"];
/**
* @description The state of the user's acceptance of the credit.
* @enum {string}
*/
- readonly state: "accepted" | "declined" | "pending";
+ state: "accepted" | "declined" | "pending";
};
/** @description A repository security advisory. */
- readonly "repository-advisory": {
+ "repository-advisory": {
/** @description The GitHub Security Advisory ID. */
readonly ghsa_id: string;
/** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id: string | null;
+ cve_id: string | null;
/**
* Format: uri
* @description The API URL for the advisory.
@@ -26391,32 +29753,32 @@ export type components = {
*/
readonly html_url: string;
/** @description A short summary of the advisory. */
- readonly summary: string;
+ summary: string;
/** @description A detailed description of what the advisory entails. */
- readonly description: string | null;
+ description: string | null;
/**
* @description The severity of the advisory.
* @enum {string|null}
*/
- readonly severity: "critical" | "high" | "medium" | "low" | null;
+ severity: "critical" | "high" | "medium" | "low" | null;
/** @description The author of the advisory. */
readonly author: components["schemas"]["simple-user"] | null;
/** @description The publisher of the advisory. */
readonly publisher: components["schemas"]["simple-user"] | null;
- readonly identifiers: readonly {
+ readonly identifiers: {
/**
* @description The type of identifier.
* @enum {string}
*/
- readonly type: "CVE" | "GHSA";
+ type: "CVE" | "GHSA";
/** @description The identifier value. */
- readonly value: string;
+ value: string;
}[];
/**
* @description The state of the advisory.
* @enum {string}
*/
- readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage";
+ state: "published" | "closed" | "withdrawn" | "draft" | "triage";
/**
* Format: date-time
* @description The date and time of when the advisory was created, in ISO 8601 format.
@@ -26446,1182 +29808,909 @@ export type components = {
/** @description Whether a private vulnerability report was accepted by the repository's administrators. */
readonly accepted: boolean;
} | null;
- readonly vulnerabilities: readonly components["schemas"]["repository-advisory-vulnerability"][] | null;
- readonly cvss: {
+ vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null;
+ cvss: {
/** @description The CVSS vector. */
- readonly vector_string: string | null;
+ vector_string: string | null;
/** @description The CVSS score. */
readonly score: number | null;
} | null;
- readonly cvss_severities?: components["schemas"]["cvss-severities"];
- readonly cwes: readonly {
+ cvss_severities?: components["schemas"]["cvss-severities"];
+ readonly cwes: {
/** @description The Common Weakness Enumeration (CWE) identifier. */
- readonly cwe_id: string;
+ cwe_id: string;
/** @description The name of the CWE. */
readonly name: string;
}[] | null;
/** @description A list of only the CWE IDs. */
- readonly cwe_ids: readonly string[] | null;
- readonly credits: readonly {
+ cwe_ids: string[] | null;
+ credits: {
/** @description The username of the user credited. */
- readonly login?: string;
- readonly type?: components["schemas"]["security-advisory-credit-types"];
+ login?: string;
+ type?: components["schemas"]["security-advisory-credit-types"];
}[] | null;
- readonly credits_detailed: readonly components["schemas"]["repository-advisory-credit"][] | null;
+ readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null;
/** @description A list of users that collaborate on the advisory. */
- readonly collaborating_users: readonly components["schemas"]["simple-user"][] | null;
+ collaborating_users: components["schemas"]["simple-user"][] | null;
/** @description A list of teams that collaborate on the advisory. */
- readonly collaborating_teams: readonly components["schemas"]["team"][] | null;
+ collaborating_teams: components["schemas"]["team"][] | null;
/** @description A temporary private fork of the advisory's repository for collaborating on a fix. */
readonly private_fork: components["schemas"]["simple-repository"] | null;
};
- readonly "actions-billing-usage": {
- /** @description The sum of the free and paid GitHub Actions minutes used. */
- readonly total_minutes_used: number;
- /** @description The total paid GitHub Actions minutes used. */
- readonly total_paid_minutes_used: number;
- /** @description The amount of free GitHub Actions minutes available. */
- readonly included_minutes: number;
- readonly minutes_used_breakdown: {
- /** @description Total minutes used on Ubuntu runner machines. */
- readonly UBUNTU?: number;
- /** @description Total minutes used on macOS runner machines. */
- readonly MACOS?: number;
- /** @description Total minutes used on Windows runner machines. */
- readonly WINDOWS?: number;
- /** @description Total minutes used on Ubuntu 4 core runner machines. */
- readonly ubuntu_4_core?: number;
- /** @description Total minutes used on Ubuntu 8 core runner machines. */
- readonly ubuntu_8_core?: number;
- /** @description Total minutes used on Ubuntu 16 core runner machines. */
- readonly ubuntu_16_core?: number;
- /** @description Total minutes used on Ubuntu 32 core runner machines. */
- readonly ubuntu_32_core?: number;
- /** @description Total minutes used on Ubuntu 64 core runner machines. */
- readonly ubuntu_64_core?: number;
- /** @description Total minutes used on Windows 4 core runner machines. */
- readonly windows_4_core?: number;
- /** @description Total minutes used on Windows 8 core runner machines. */
- readonly windows_8_core?: number;
- /** @description Total minutes used on Windows 16 core runner machines. */
- readonly windows_16_core?: number;
- /** @description Total minutes used on Windows 32 core runner machines. */
- readonly windows_32_core?: number;
- /** @description Total minutes used on Windows 64 core runner machines. */
- readonly windows_64_core?: number;
- /** @description Total minutes used on macOS 12 core runner machines. */
- readonly macos_12_core?: number;
- /** @description Total minutes used on all runner machines. */
- readonly total?: number;
- };
- };
- readonly "packages-billing-usage": {
- /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */
- readonly total_gigabytes_bandwidth_used: number;
- /** @description Total paid storage space (GB) for GitHuub Packages. */
- readonly total_paid_gigabytes_bandwidth_used: number;
- /** @description Free storage space (GB) for GitHub Packages. */
- readonly included_gigabytes_bandwidth: number;
- };
- readonly "combined-billing-usage": {
- /** @description Numbers of days left in billing cycle. */
- readonly days_left_in_billing_cycle: number;
- /** @description Estimated storage space (GB) used in billing cycle. */
- readonly estimated_paid_storage_for_month: number;
- /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */
- readonly estimated_storage_for_month: number;
+ /**
+ * Check immutable releases organization settings
+ * @description Check immutable releases settings for an organization.
+ */
+ "immutable-releases-organization-settings": {
+ /**
+ * @description The policy that controls how immutable releases are enforced in the organization.
+ * @example all
+ * @enum {string}
+ */
+ enforced_repositories: "all" | "none" | "selected";
+ /** @description The API URL to use to get or set the selected repositories for immutable releases enforcement, when `enforced_repositories` is set to `selected`. */
+ selected_repositories_url?: string;
};
/**
* Hosted compute network configuration
* @description A hosted compute network configuration.
*/
- readonly "network-configuration": {
+ "network-configuration": {
/**
* @description The unique identifier of the network configuration.
* @example 123ABC456DEF789
*/
- readonly id: string;
+ id: string;
/**
* @description The name of the network configuration.
* @example my-network-configuration
*/
- readonly name: string;
+ name: string;
/**
* @description The hosted compute service the network configuration supports.
* @enum {string}
*/
- readonly compute_service?: "none" | "actions" | "codespaces";
+ compute_service?: "none" | "actions" | "codespaces";
/**
* @description The unique identifier of each network settings in the configuration.
* @example 123ABC456DEF789
*/
- readonly network_settings_ids?: readonly string[];
+ network_settings_ids?: string[];
+ /**
+ * @description The unique identifier of each failover network settings in the configuration.
+ * @example 123ABC456DEF789
+ */
+ failover_network_settings_ids?: string[];
+ /**
+ * @description Indicates whether the failover network resource is enabled.
+ * @example true
+ */
+ failover_network_enabled?: boolean;
/**
* Format: date-time
* @description The time at which the network configuration was created, in ISO 8601 format.
* @example 2024-04-26T11:31:07Z
*/
- readonly created_on: string | null;
+ created_on: string | null;
};
/**
* Hosted compute network settings resource
* @description A hosted compute network settings resource.
*/
- readonly "network-settings": {
+ "network-settings": {
/**
* @description The unique identifier of the network settings resource.
* @example 220F78DACB92BBFBC5E6F22DE1CCF52309D
*/
- readonly id: string;
+ id: string;
/**
* @description The identifier of the network configuration that is using this settings resource.
* @example 934E208B3EE0BD60CF5F752C426BFB53562
*/
- readonly network_configuration_id?: string;
+ network_configuration_id?: string;
/**
* @description The name of the network settings resource.
* @example my-network-settings
*/
- readonly name: string;
+ name: string;
/**
* @description The subnet this network settings resource is configured for.
* @example /subscriptions/14839728-3ad9-43ab-bd2b-fa6ad0f75e2a/resourceGroups/my-rg/providers/Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet
*/
- readonly subnet_id: string;
+ subnet_id: string;
/**
* @description The location of the subnet this network settings resource is configured for.
* @example eastus
*/
- readonly region: string;
+ region: string;
};
/**
* Team Organization
* @description Team Organization
*/
- readonly "team-organization": {
+ "team-organization": {
/** @example github */
- readonly login: string;
+ login: string;
/** @example 1 */
- readonly id: number;
+ id: number;
/** @example MDEyOk9yZ2FuaXphdGlvbjE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/repos
*/
- readonly repos_url: string;
+ repos_url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/events
*/
- readonly events_url: string;
+ events_url: string;
/** @example https://api.github.com/orgs/github/hooks */
- readonly hooks_url: string;
+ hooks_url: string;
/** @example https://api.github.com/orgs/github/issues */
- readonly issues_url: string;
+ issues_url: string;
/** @example https://api.github.com/orgs/github/members{/member} */
- readonly members_url: string;
+ members_url: string;
/** @example https://api.github.com/orgs/github/public_members{/member} */
- readonly public_members_url: string;
+ public_members_url: string;
/** @example https://github.com/images/error/octocat_happy.gif */
- readonly avatar_url: string;
+ avatar_url: string;
/** @example A great organization */
- readonly description: string | null;
+ description: string | null;
/** @example github */
- readonly name?: string;
+ name?: string;
/** @example GitHub */
- readonly company?: string;
+ company?: string;
/**
* Format: uri
* @example https://github.com/blog
*/
- readonly blog?: string;
+ blog?: string;
/** @example San Francisco */
- readonly location?: string;
+ location?: string;
/**
* Format: email
* @example octocat@github.com
*/
- readonly email?: string;
+ email?: string;
/** @example github */
- readonly twitter_username?: string | null;
+ twitter_username?: string | null;
/** @example true */
- readonly is_verified?: boolean;
+ is_verified?: boolean;
/** @example true */
- readonly has_organization_projects: boolean;
+ has_organization_projects: boolean;
/** @example true */
- readonly has_repository_projects: boolean;
+ has_repository_projects: boolean;
/** @example 2 */
- readonly public_repos: number;
+ public_repos: number;
/** @example 1 */
- readonly public_gists: number;
+ public_gists: number;
/** @example 20 */
- readonly followers: number;
+ followers: number;
/** @example 0 */
- readonly following: number;
+ following: number;
/**
* Format: uri
* @example https://github.com/octocat
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: date-time
* @example 2008-01-14T04:33:35Z
*/
- readonly created_at: string;
+ created_at: string;
/** @example Organization */
- readonly type: string;
+ type: string;
/** @example 100 */
- readonly total_private_repos?: number;
+ total_private_repos?: number;
/** @example 100 */
- readonly owned_private_repos?: number;
+ owned_private_repos?: number;
/** @example 81 */
- readonly private_gists?: number | null;
+ private_gists?: number | null;
/** @example 10000 */
- readonly disk_usage?: number | null;
+ disk_usage?: number | null;
/** @example 8 */
- readonly collaborators?: number | null;
+ collaborators?: number | null;
/**
* Format: email
* @example org@example.com
*/
- readonly billing_email?: string | null;
- readonly plan?: {
- readonly name: string;
- readonly space: number;
- readonly private_repos: number;
- readonly filled_seats?: number;
- readonly seats?: number;
+ billing_email?: string | null;
+ plan?: {
+ name: string;
+ space: number;
+ private_repos: number;
+ filled_seats?: number;
+ seats?: number;
};
- readonly default_repository_permission?: string | null;
+ default_repository_permission?: string | null;
/** @example true */
- readonly members_can_create_repositories?: boolean | null;
+ members_can_create_repositories?: boolean | null;
/** @example true */
- readonly two_factor_requirement_enabled?: boolean | null;
+ two_factor_requirement_enabled?: boolean | null;
/** @example all */
- readonly members_allowed_repository_creation_type?: string;
+ members_allowed_repository_creation_type?: string;
/** @example true */
- readonly members_can_create_public_repositories?: boolean;
+ members_can_create_public_repositories?: boolean;
/** @example true */
- readonly members_can_create_private_repositories?: boolean;
+ members_can_create_private_repositories?: boolean;
/** @example true */
- readonly members_can_create_internal_repositories?: boolean;
+ members_can_create_internal_repositories?: boolean;
/** @example true */
- readonly members_can_create_pages?: boolean;
+ members_can_create_pages?: boolean;
/** @example true */
- readonly members_can_create_public_pages?: boolean;
+ members_can_create_public_pages?: boolean;
/** @example true */
- readonly members_can_create_private_pages?: boolean;
+ members_can_create_private_pages?: boolean;
/** @example false */
- readonly members_can_fork_private_repositories?: boolean | null;
+ members_can_fork_private_repositories?: boolean | null;
/** @example false */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: date-time */
- readonly archived_at: string | null;
+ archived_at: string | null;
};
+ /**
+ * @description The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.
+ * @example cn=Enterprise Ops,ou=teams,dc=github,dc=com
+ */
+ "ldap-dn": string;
/**
* Full Team
* @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly "team-full": {
+ "team-full": {
/**
* @description Unique identifier of the team
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDQ6VGVhbTE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the team
* @example https://api.github.com/organizations/1/team/1
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/orgs/rails/teams/core
*/
- readonly html_url: string;
+ html_url: string;
/**
* @description Name of the team
* @example Developers
*/
- readonly name: string;
+ name: string;
/** @example justice-league */
- readonly slug: string;
+ slug: string;
/** @example A great team. */
- readonly description: string | null;
+ description: string | null;
/**
* @description The level of privacy this team should have
* @example closed
* @enum {string}
*/
- readonly privacy?: "closed" | "secret";
+ privacy?: "closed" | "secret";
/**
* @description The notification setting the team has set
* @example notifications_enabled
* @enum {string}
*/
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
/**
* @description Permission that the team will have for its repositories
* @example push
*/
- readonly permission: string;
+ permission: string;
/** @example https://api.github.com/organizations/1/team/1/members{/member} */
- readonly members_url: string;
+ members_url: string;
/**
* Format: uri
* @example https://api.github.com/organizations/1/team/1/repos
*/
- readonly repositories_url: string;
- readonly parent?: components["schemas"]["nullable-team-simple"];
+ repositories_url: string;
+ parent?: components["schemas"]["nullable-team-simple"];
/** @example 3 */
- readonly members_count: number;
+ members_count: number;
/** @example 10 */
- readonly repos_count: number;
+ repos_count: number;
/**
* Format: date-time
* @example 2017-07-14T16:53:42Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2017-08-17T12:37:15Z
*/
- readonly updated_at: string;
- readonly organization: components["schemas"]["team-organization"];
- /**
- * @description Distinguished Name (DN) that team maps to within LDAP environment
- * @example uid=example,ou=users,dc=github,dc=com
- */
- readonly ldap_dn?: string;
- };
- /**
- * Team Discussion
- * @description A team discussion is a persistent record of a free-form conversation within a team.
- */
- readonly "team-discussion": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the discussion.
- * @example Please suggest improvements to our workflow in comments.
- */
- readonly body: string;
- /** @example Hi! This is an area for us to collaborate as a team
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /** @example 0 */
- readonly comments_count: number;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments
- */
- readonly comments_url: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1
- */
- readonly html_url: string;
- /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */
- readonly node_id: string;
- /**
- * @description The unique sequence number of a team discussion.
- * @example 42
- */
- readonly number: number;
- /**
- * @description Whether or not this discussion should be pinned for easy retrieval.
- * @example true
- */
- readonly pinned: boolean;
- /**
- * @description Whether or not this discussion should be restricted to team members and organization owners.
- * @example true
- */
- readonly private: boolean;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027
- */
- readonly team_url: string;
- /**
- * @description The title of the discussion.
- * @example How can we improve our workflow?
- */
- readonly title: string;
- /**
- * Format: date-time
- * @example 2018-01-25T18:56:31Z
- */
- readonly updated_at: string;
+ updated_at: string;
+ organization: components["schemas"]["team-organization"];
+ ldap_dn?: components["schemas"]["ldap-dn"];
/**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2343027/discussions/1
- */
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Team Discussion Comment
- * @description A reply to a discussion within a team.
- */
- readonly "team-discussion-comment": {
- readonly author: components["schemas"]["nullable-simple-user"];
- /**
- * @description The main text of the comment.
- * @example I agree with this suggestion.
- */
- readonly body: string;
- /** @example Do you like apples?
*/
- readonly body_html: string;
- /**
- * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
- * @example 0307116bbf7ced493b8d8a346c650b71
- */
- readonly body_version: string;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly created_at: string;
- /** Format: date-time */
- readonly last_edited_at: string | null;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1
+ * @description The ownership type of the team
+ * @enum {string}
*/
- readonly discussion_url: string;
+ type: "enterprise" | "organization";
/**
- * Format: uri
- * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
+ * @description Unique identifier of the organization to which this team belongs
+ * @example 37
*/
- readonly html_url: string;
- /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */
- readonly node_id: string;
+ organization_id?: number;
/**
- * @description The unique sequence number of a team discussion comment.
+ * @description Unique identifier of the enterprise to which this team belongs
* @example 42
*/
- readonly number: number;
- /**
- * Format: date-time
- * @example 2018-01-15T23:53:58Z
- */
- readonly updated_at: string;
- /**
- * Format: uri
- * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
- */
- readonly url: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Reaction
- * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
- */
- readonly reaction: {
- /** @example 1 */
- readonly id: number;
- /** @example MDg6UmVhY3Rpb24x */
- readonly node_id: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- /**
- * @description The reaction to use
- * @example heart
- * @enum {string}
- */
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /**
- * Format: date-time
- * @example 2016-05-20T20:09:31Z
- */
- readonly created_at: string;
+ enterprise_id?: number;
};
/**
* Team Membership
* @description Team Membership
*/
- readonly "team-membership": {
+ "team-membership": {
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description The role of the user in the team.
* @default member
* @example member
* @enum {string}
*/
- readonly role: "member" | "maintainer";
+ role: "member" | "maintainer";
/**
* @description The state of the user's membership in the team.
* @enum {string}
*/
- readonly state: "active" | "pending";
- };
- /**
- * Team Project
- * @description A team's access to a project.
- */
- readonly "team-project": {
- readonly owner_url: string;
- readonly url: string;
- readonly html_url: string;
- readonly columns_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly name: string;
- readonly body: string | null;
- readonly number: number;
- readonly state: string;
- readonly creator: components["schemas"]["simple-user"];
- readonly created_at: string;
- readonly updated_at: string;
- /** @description The organization permission for this project. Only present when owner is an organization. */
- readonly organization_permission?: string;
- /** @description Whether the project is private or not. Only present when owner is an organization. */
- readonly private?: boolean;
- readonly permissions: {
- readonly read: boolean;
- readonly write: boolean;
- readonly admin: boolean;
- };
+ state: "active" | "pending";
};
/**
* Team Repository
* @description A team's access to a repository.
*/
- readonly "team-repository": {
+ "team-repository": {
/**
* @description Unique identifier of the repository
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the repository.
* @example Team Environment
*/
- readonly name: string;
+ name: string;
/** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
+ full_name: string;
+ license: components["schemas"]["nullable-license-simple"];
+ forks: number;
+ permissions?: {
+ admin: boolean;
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
};
/** @example admin */
- readonly role_name?: string;
- readonly owner: components["schemas"]["nullable-simple-user"];
+ role_name?: string;
+ owner: components["schemas"]["nullable-simple-user"];
/**
* @description Whether the repository is private or public.
* @default false
*/
- readonly private: boolean;
+ private: boolean;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World
*/
- readonly html_url: string;
+ html_url: string;
/** @example This your first repo! */
- readonly description: string | null;
- readonly fork: boolean;
+ description: string | null;
+ fork: boolean;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World
*/
- readonly url: string;
+ url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
+ archive_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
+ assignees_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
+ blobs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
+ branches_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
+ comments_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
+ commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
+ compare_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ contents_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- readonly contributors_url: string;
+ contributors_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- readonly deployments_url: string;
+ deployments_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- readonly downloads_url: string;
+ downloads_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/events
*/
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- readonly forks_url: string;
+ forks_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
+ git_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
+ issues_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
+ keys_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- readonly labels_url: string;
+ labels_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- readonly languages_url: string;
+ languages_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- readonly merges_url: string;
+ merges_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
+ milestones_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
+ notifications_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
+ pulls_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
+ releases_url: string;
/** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
+ ssh_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- readonly stargazers_url: string;
+ stargazers_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- readonly subscribers_url: string;
+ subscribers_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- readonly subscription_url: string;
+ subscription_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- readonly tags_url: string;
+ tags_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- readonly teams_url: string;
+ teams_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
+ trees_url: string;
/** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
+ clone_url: string;
/**
* Format: uri
* @example git:git.example.com/octocat/Hello-World
*/
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- readonly hooks_url: string;
+ hooks_url: string;
/**
* Format: uri
* @example https://svn.github.com/octocat/Hello-World
*/
- readonly svn_url: string;
+ svn_url: string;
/**
* Format: uri
* @example https://github.com
*/
- readonly homepage: string | null;
- readonly language: string | null;
+ homepage: string | null;
+ language: string | null;
/** @example 9 */
- readonly forks_count: number;
+ forks_count: number;
/** @example 80 */
- readonly stargazers_count: number;
+ stargazers_count: number;
/** @example 80 */
- readonly watchers_count: number;
+ watchers_count: number;
/** @example 108 */
- readonly size: number;
+ size: number;
/**
* @description The default branch of the repository.
* @example master
*/
- readonly default_branch: string;
+ default_branch: string;
/** @example 0 */
- readonly open_issues_count: number;
+ open_issues_count: number;
/**
* @description Whether this repository acts as a template that can be used to generate new repositories.
* @default false
* @example true
*/
- readonly is_template: boolean;
- readonly topics?: readonly string[];
+ is_template: boolean;
+ topics?: string[];
/**
* @description Whether issues are enabled.
* @default true
* @example true
*/
- readonly has_issues: boolean;
+ has_issues: boolean;
/**
* @description Whether projects are enabled.
* @default true
* @example true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
* @example true
*/
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
+ has_wiki: boolean;
+ has_pages: boolean;
/**
* @description Whether downloads are enabled.
* @default true
* @example true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
* @default public
*/
- readonly visibility: string;
+ visibility: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string | null;
+ pushed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ created_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
* @example true
*/
- readonly allow_rebase_merge: boolean;
- readonly temp_clone_token?: string;
+ allow_rebase_merge: boolean;
+ temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
* @example true
*/
- readonly allow_squash_merge: boolean;
+ allow_squash_merge: boolean;
/**
* @description Whether to allow Auto-merge to be used on pull requests.
* @default false
* @example false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
* @example false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
* @example true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow forking this repo
* @default false
* @example false
*/
- readonly allow_forking: boolean;
+ allow_forking: boolean;
/**
* @description Whether to require contributors to sign off on web-based commits
* @default false
* @example false
*/
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
- };
- /**
- * Project Card
- * @description Project cards represent a scope of work.
- */
- readonly "project-card": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/cards/1478
- */
- readonly url: string;
- /**
- * Format: int64
- * @description The project card's ID
- * @example 42
- */
- readonly id: number;
- /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */
- readonly node_id: string;
- /** @example Add payload for delete Project column */
- readonly note: string | null;
- readonly creator: components["schemas"]["nullable-simple-user"];
- /**
- * Format: date-time
- * @example 2016-09-05T14:21:06Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:20:22Z
- */
- readonly updated_at: string;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- readonly archived?: boolean;
- readonly column_name?: string;
- readonly project_id?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly column_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/api-playground/projects-test/issues/3
- */
- readonly content_url?: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
- };
- /**
- * Project Column
- * @description Project columns contain cards of work.
- */
- readonly "project-column": {
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367
- */
- readonly url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/120
- */
- readonly project_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/projects/columns/367/cards
- */
- readonly cards_url: string;
- /**
- * @description The unique identifier of the project column
- * @example 42
- */
- readonly id: number;
- /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */
- readonly node_id: string;
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
- readonly name: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:18:44Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2016-09-05T14:22:28Z
- */
- readonly updated_at: string;
- };
- /**
- * Project Collaborator Permission
- * @description Project Collaborator Permission
- */
- readonly "project-collaborator-permission": {
- readonly permission: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ web_commit_signoff_required: boolean;
+ subscribers_count?: number;
+ network_count?: number;
+ open_issues: number;
+ watchers: number;
+ master_branch?: string;
};
/** Rate Limit */
- readonly "rate-limit": {
- readonly limit: number;
- readonly remaining: number;
- readonly reset: number;
- readonly used: number;
+ "rate-limit": {
+ limit: number;
+ remaining: number;
+ reset: number;
+ used: number;
};
/**
* Rate Limit Overview
* @description Rate Limit Overview
*/
- readonly "rate-limit-overview": {
- readonly resources: {
- readonly core: components["schemas"]["rate-limit"];
- readonly graphql?: components["schemas"]["rate-limit"];
- readonly search: components["schemas"]["rate-limit"];
- readonly code_search?: components["schemas"]["rate-limit"];
- readonly source_import?: components["schemas"]["rate-limit"];
- readonly integration_manifest?: components["schemas"]["rate-limit"];
- readonly code_scanning_upload?: components["schemas"]["rate-limit"];
- readonly actions_runner_registration?: components["schemas"]["rate-limit"];
- readonly scim?: components["schemas"]["rate-limit"];
- readonly dependency_snapshots?: components["schemas"]["rate-limit"];
- readonly code_scanning_autofix?: components["schemas"]["rate-limit"];
+ "rate-limit-overview": {
+ resources: {
+ core: components["schemas"]["rate-limit"];
+ graphql?: components["schemas"]["rate-limit"];
+ search: components["schemas"]["rate-limit"];
+ code_search?: components["schemas"]["rate-limit"];
+ source_import?: components["schemas"]["rate-limit"];
+ integration_manifest?: components["schemas"]["rate-limit"];
+ code_scanning_upload?: components["schemas"]["rate-limit"];
+ actions_runner_registration?: components["schemas"]["rate-limit"];
+ scim?: components["schemas"]["rate-limit"];
+ dependency_snapshots?: components["schemas"]["rate-limit"];
+ dependency_sbom?: components["schemas"]["rate-limit"];
+ code_scanning_autofix?: components["schemas"]["rate-limit"];
};
- readonly rate: components["schemas"]["rate-limit"];
+ rate: components["schemas"]["rate-limit"];
};
/**
* Artifact
* @description An artifact
*/
- readonly artifact: {
+ artifact: {
/** @example 5 */
- readonly id: number;
+ id: number;
/** @example MDEwOkNoZWNrU3VpdGU1 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the artifact.
* @example AdventureWorks.Framework
*/
- readonly name: string;
+ name: string;
/**
* @description The size in bytes of the artifact.
* @example 12345
*/
- readonly size_in_bytes: number;
+ size_in_bytes: number;
/** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5 */
- readonly url: string;
+ url: string;
/** @example https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip */
- readonly archive_download_url: string;
+ archive_download_url: string;
/** @description Whether or not the artifact has expired. */
- readonly expired: boolean;
+ expired: boolean;
/** Format: date-time */
- readonly created_at: string | null;
+ created_at: string | null;
/** Format: date-time */
- readonly expires_at: string | null;
+ expires_at: string | null;
/** Format: date-time */
- readonly updated_at: string | null;
- readonly workflow_run?: {
+ updated_at: string | null;
+ /**
+ * @description The SHA256 digest of the artifact. This field will only be populated on artifacts uploaded with upload-artifact v4 or newer. For older versions, this field will be null.
+ * @example sha256:cfc3236bdad15b5898bca8408945c9e19e1917da8704adc20eaa618444290a8c
+ */
+ digest?: string | null;
+ workflow_run?: {
/** @example 10 */
- readonly id?: number;
+ id?: number;
/** @example 42 */
- readonly repository_id?: number;
+ repository_id?: number;
/** @example 42 */
- readonly head_repository_id?: number;
+ head_repository_id?: number;
/** @example main */
- readonly head_branch?: string;
+ head_branch?: string;
/** @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d */
- readonly head_sha?: string;
+ head_sha?: string;
} | null;
};
+ /**
+ * Actions cache retention limit for a repository
+ * @description GitHub Actions cache retention policy for a repository.
+ */
+ "actions-cache-retention-limit-for-repository": {
+ /**
+ * @description The maximum number of days to keep caches in this repository.
+ * @example 14
+ */
+ max_cache_retention_days?: number;
+ };
+ /**
+ * Actions cache storage limit for a repository
+ * @description GitHub Actions cache storage policy for a repository.
+ */
+ "actions-cache-storage-limit-for-repository": {
+ /**
+ * @description The maximum total cache size for this repository, in gigabytes.
+ * @example 10
+ */
+ max_cache_size_gb?: number;
+ };
/**
* Repository actions caches
* @description Repository actions caches
*/
- readonly "actions-cache-list": {
+ "actions-cache-list": {
/**
* @description Total number of caches
* @example 2
*/
- readonly total_count: number;
+ total_count: number;
/** @description Array of caches */
- readonly actions_caches: readonly {
+ actions_caches: {
/** @example 2 */
- readonly id?: number;
+ id?: number;
/** @example refs/heads/main */
- readonly ref?: string;
+ ref?: string;
/** @example Linux-node-958aff96db2d75d67787d1e634ae70b659de937b */
- readonly key?: string;
+ key?: string;
/** @example 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 */
- readonly version?: string;
+ version?: string;
/**
* Format: date-time
* @example 2019-01-24T22:45:36.000Z
*/
- readonly last_accessed_at?: string;
+ last_accessed_at?: string;
/**
* Format: date-time
* @example 2019-01-24T22:45:36.000Z
*/
- readonly created_at?: string;
+ created_at?: string;
/** @example 1024 */
- readonly size_in_bytes?: number;
+ size_in_bytes?: number;
}[];
};
/**
* Job
* @description Information of a job execution in a workflow run
*/
- readonly job: {
+ job: {
/**
* @description The id of the job.
* @example 21
*/
- readonly id: number;
+ id: number;
/**
* @description The id of the associated workflow run.
* @example 5
*/
- readonly run_id: number;
+ run_id: number;
/** @example https://api.github.com/repos/github/hello-world/actions/runs/5 */
- readonly run_url: string;
+ run_url: string;
/**
* @description Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.
* @example 1
*/
- readonly run_attempt?: number;
+ run_attempt?: number;
/** @example MDg6Q2hlY2tSdW40 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The SHA of the commit that is being run.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha: string;
+ head_sha: string;
/** @example https://api.github.com/repos/github/hello-world/actions/jobs/21 */
- readonly url: string;
+ url: string;
/** @example https://github.com/github/hello-world/runs/4 */
- readonly html_url: string | null;
+ html_url: string | null;
/**
* @description The phase of the lifecycle that the job is currently in.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @description The outcome of the job.
* @example success
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
/**
* Format: date-time
* @description The time that the job created, in ISO 8601 format.
* @example 2019-08-08T08:00:00-07:00
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The time that the job started, in ISO 8601 format.
* @example 2019-08-08T08:00:00-07:00
*/
- readonly started_at: string;
+ started_at: string;
/**
* Format: date-time
* @description The time that the job finished, in ISO 8601 format.
* @example 2019-08-08T08:00:00-07:00
*/
- readonly completed_at: string | null;
+ completed_at: string | null;
/**
* @description The name of the job.
* @example test-coverage
*/
- readonly name: string;
+ name: string;
/** @description Steps in this job. */
- readonly steps?: readonly {
+ steps?: {
/**
* @description The phase of the lifecycle that the job is currently in.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ status: "queued" | "in_progress" | "completed";
/**
* @description The outcome of the job.
* @example success
*/
- readonly conclusion: string | null;
+ conclusion: string | null;
/**
* @description The name of the job.
* @example test-coverage
*/
- readonly name: string;
+ name: string;
/** @example 1 */
- readonly number: number;
+ number: number;
/**
* Format: date-time
* @description The time that the step started, in ISO 8601 format.
* @example 2019-08-08T08:00:00-07:00
*/
- readonly started_at?: string | null;
+ started_at?: string | null;
/**
* Format: date-time
* @description The time that the job finished, in ISO 8601 format.
* @example 2019-08-08T08:00:00-07:00
*/
- readonly completed_at?: string | null;
+ completed_at?: string | null;
}[];
/** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- readonly check_run_url: string;
+ check_run_url: string;
/**
* @description Labels for the workflow job. Specified by the "runs_on" attribute in the action's workflow file.
* @example [
@@ -27630,96 +30719,97 @@ export type components = {
* "bar"
* ]
*/
- readonly labels: readonly string[];
+ labels: string[];
/**
* @description The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
* @example 1
*/
- readonly runner_id: number | null;
+ runner_id: number | null;
/**
* @description The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
* @example my runner
*/
- readonly runner_name: string | null;
+ runner_name: string | null;
/**
* @description The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
* @example 2
*/
- readonly runner_group_id: number | null;
+ runner_group_id: number | null;
/**
* @description The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)
* @example my runner group
*/
- readonly runner_group_name: string | null;
+ runner_group_name: string | null;
/**
* @description The name of the workflow.
* @example Build
*/
- readonly workflow_name: string | null;
+ workflow_name: string | null;
/**
* @description The name of the current branch.
* @example main
*/
- readonly head_branch: string | null;
+ head_branch: string | null;
};
/**
* Actions OIDC subject customization for a repository
* @description Actions OIDC subject customization for a repository
*/
- readonly "oidc-custom-sub-repo": {
+ "oidc-custom-sub-repo": {
/** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */
- readonly use_default: boolean;
+ use_default: boolean;
/** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */
- readonly include_claim_keys?: readonly string[];
+ include_claim_keys?: string[];
};
/**
* Actions Secret
* @description Set secrets for GitHub Actions.
*/
- readonly "actions-secret": {
+ "actions-secret": {
/**
* @description The name of the secret.
* @example SECRET_TOKEN
*/
- readonly name: string;
+ name: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/** Actions Variable */
- readonly "actions-variable": {
+ "actions-variable": {
/**
* @description The name of the variable.
* @example USERNAME
*/
- readonly name: string;
+ name: string;
/**
* @description The value of the variable.
* @example octocat
*/
- readonly value: string;
+ value: string;
/**
* Format: date-time
* @description The date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
* @example 2019-01-24T22:45:36.000Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
* @example 2019-01-24T22:45:36.000Z
*/
- readonly updated_at: string;
+ updated_at: string;
};
/** @description Whether GitHub Actions is enabled on the repository. */
- readonly "actions-enabled": boolean;
- readonly "actions-repository-permissions": {
- readonly enabled: components["schemas"]["actions-enabled"];
- readonly allowed_actions?: components["schemas"]["allowed-actions"];
- readonly selected_actions_url?: components["schemas"]["selected-actions-url"];
+ "actions-enabled": boolean;
+ "actions-repository-permissions": {
+ enabled: components["schemas"]["actions-enabled"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
+ selected_actions_url?: components["schemas"]["selected-actions-url"];
+ sha_pinning_required?: components["schemas"]["sha-pinning-required"];
};
- readonly "actions-workflow-access-to-repository": {
+ "actions-workflow-access-to-repository": {
/**
* @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the
* repository.
@@ -27727,508 +30817,501 @@ export type components = {
* `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization.
* @enum {string}
*/
- readonly access_level: "none" | "user" | "organization";
+ access_level: "none" | "user" | "organization";
};
/**
* Referenced workflow
* @description A workflow referenced/reused by the initial caller workflow
*/
- readonly "referenced-workflow": {
- readonly path: string;
- readonly sha: string;
- readonly ref?: string;
- };
- /** Pull Request Minimal */
- readonly "pull-request-minimal": {
- /** Format: int64 */
- readonly id: number;
- readonly number: number;
- readonly url: string;
- readonly head: {
- readonly ref: string;
- readonly sha: string;
- readonly repo: {
- /** Format: int64 */
- readonly id: number;
- readonly url: string;
- readonly name: string;
- };
- };
- readonly base: {
- readonly ref: string;
- readonly sha: string;
- readonly repo: {
- /** Format: int64 */
- readonly id: number;
- readonly url: string;
- readonly name: string;
- };
- };
+ "referenced-workflow": {
+ path: string;
+ sha: string;
+ ref?: string;
};
/**
* Simple Commit
* @description A commit.
*/
- readonly "nullable-simple-commit": {
+ "nullable-simple-commit": {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly id: string;
+ id: string;
/** @description SHA for the commit's tree */
- readonly tree_id: string;
+ tree_id: string;
/**
* @description Message describing the purpose of the commit
* @example Fix #42
*/
- readonly message: string;
+ message: string;
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly timestamp: string;
+ timestamp: string;
/** @description Information about the Git author */
- readonly author: {
+ author: {
/**
* @description Name of the commit's author
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
/**
* Format: email
* @description Git email address of the commit's author
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
} | null;
/** @description Information about the Git committer */
- readonly committer: {
+ committer: {
/**
* @description Name of the commit's committer
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
/**
* Format: email
* @description Git email address of the commit's committer
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
} | null;
} | null;
/**
* Workflow Run
* @description An invocation of a workflow
*/
- readonly "workflow-run": {
+ "workflow-run": {
/**
* @description The ID of the workflow run.
* @example 5
*/
- readonly id: number;
+ id: number;
/**
* @description The name of the workflow run.
* @example Build
*/
- readonly name?: string | null;
+ name?: string | null;
/** @example MDEwOkNoZWNrU3VpdGU1 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The ID of the associated check suite.
* @example 42
*/
- readonly check_suite_id?: number;
+ check_suite_id?: number;
/**
* @description The node ID of the associated check suite.
* @example MDEwOkNoZWNrU3VpdGU0Mg==
*/
- readonly check_suite_node_id?: string;
+ check_suite_node_id?: string;
/** @example master */
- readonly head_branch: string | null;
+ head_branch: string | null;
/**
* @description The SHA of the head commit that points to the version of the workflow being run.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha: string;
+ head_sha: string;
/**
* @description The full path of the workflow
* @example octocat/octo-repo/.github/workflows/ci.yml@main
*/
- readonly path: string;
+ path: string;
/**
* @description The auto incrementing run number for the workflow run.
* @example 106
*/
- readonly run_number: number;
+ run_number: number;
/**
* @description Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.
* @example 1
*/
- readonly run_attempt?: number;
- readonly referenced_workflows?: readonly components["schemas"]["referenced-workflow"][] | null;
+ run_attempt?: number;
+ referenced_workflows?: components["schemas"]["referenced-workflow"][] | null;
/** @example push */
- readonly event: string;
+ event: string;
/** @example completed */
- readonly status: string | null;
+ status: string | null;
/** @example neutral */
- readonly conclusion: string | null;
+ conclusion: string | null;
/**
* @description The ID of the parent workflow.
* @example 5
*/
- readonly workflow_id: number;
+ workflow_id: number;
/**
* @description The URL to the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5
*/
- readonly url: string;
+ url: string;
/** @example https://github.com/github/hello-world/suites/4 */
- readonly html_url: string;
+ html_url: string;
/** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the workflow run. The returned pull requests do not necessarily indicate pull requests that triggered the run. */
- readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null;
+ pull_requests: components["schemas"]["pull-request-minimal"][] | null;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
- readonly actor?: components["schemas"]["simple-user"];
- readonly triggering_actor?: components["schemas"]["simple-user"];
+ updated_at: string;
+ actor?: components["schemas"]["simple-user"];
+ triggering_actor?: components["schemas"]["simple-user"];
/**
* Format: date-time
* @description The start time of the latest run. Resets on re-run.
*/
- readonly run_started_at?: string;
+ run_started_at?: string;
/**
* @description The URL to the jobs for the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/jobs
*/
- readonly jobs_url: string;
+ jobs_url: string;
/**
* @description The URL to download the logs for the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/logs
*/
- readonly logs_url: string;
+ logs_url: string;
/**
* @description The URL to the associated check suite.
* @example https://api.github.com/repos/github/hello-world/check-suites/12
*/
- readonly check_suite_url: string;
+ check_suite_url: string;
/**
* @description The URL to the artifacts for the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts
*/
- readonly artifacts_url: string;
+ artifacts_url: string;
/**
* @description The URL to cancel the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/cancel
*/
- readonly cancel_url: string;
+ cancel_url: string;
/**
* @description The URL to rerun the workflow run.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/rerun
*/
- readonly rerun_url: string;
+ rerun_url: string;
/**
* @description The URL to the previous attempted run of this workflow, if one exists.
* @example https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3
*/
- readonly previous_attempt_url?: string | null;
+ previous_attempt_url?: string | null;
/**
* @description The URL to the workflow.
* @example https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml
*/
- readonly workflow_url: string;
- readonly head_commit: components["schemas"]["nullable-simple-commit"];
- readonly repository: components["schemas"]["minimal-repository"];
- readonly head_repository: components["schemas"]["minimal-repository"];
+ workflow_url: string;
+ head_commit: components["schemas"]["nullable-simple-commit"];
+ repository: components["schemas"]["minimal-repository"];
+ head_repository: components["schemas"]["minimal-repository"];
/** @example 5 */
- readonly head_repository_id?: number;
+ head_repository_id?: number;
/**
* @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
* @example Simple Workflow
*/
- readonly display_title: string;
+ display_title: string;
};
/**
* Environment Approval
* @description An entry in the reviews log for environment deployments
*/
- readonly "environment-approvals": {
+ "environment-approvals": {
/** @description The list of environments that were approved or rejected */
- readonly environments: readonly {
+ environments: {
/**
* @description The id of the environment.
* @example 56780428
*/
- readonly id?: number;
+ id?: number;
/** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- readonly node_id?: string;
+ node_id?: string;
/**
* @description The name of the environment.
* @example staging
*/
- readonly name?: string;
+ name?: string;
/** @example https://api.github.com/repos/github/hello-world/environments/staging */
- readonly url?: string;
+ url?: string;
/** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- readonly html_url?: string;
+ html_url?: string;
/**
* Format: date-time
* @description The time that the environment was created, in ISO 8601 format.
* @example 2020-11-23T22:00:40Z
*/
- readonly created_at?: string;
+ created_at?: string;
/**
* Format: date-time
* @description The time that the environment was last updated, in ISO 8601 format.
* @example 2020-11-23T22:00:40Z
*/
- readonly updated_at?: string;
+ updated_at?: string;
}[];
/**
* @description Whether deployment to the environment(s) was approved or rejected or pending (with comments)
* @example approved
* @enum {string}
*/
- readonly state: "approved" | "rejected" | "pending";
- readonly user: components["schemas"]["simple-user"];
+ state: "approved" | "rejected" | "pending";
+ user: components["schemas"]["simple-user"];
/**
* @description The comment submitted with the deployment review
* @example Ship it!
*/
- readonly comment: string;
+ comment: string;
};
- readonly "review-custom-gates-comment-required": {
+ "review-custom-gates-comment-required": {
/** @description The name of the environment to approve or reject. */
- readonly environment_name: string;
+ environment_name: string;
/** @description Comment associated with the pending deployment protection rule. **Required when state is not provided.** */
- readonly comment: string;
+ comment: string;
};
- readonly "review-custom-gates-state-required": {
+ "review-custom-gates-state-required": {
/** @description The name of the environment to approve or reject. */
- readonly environment_name: string;
+ environment_name: string;
/**
* @description Whether to approve or reject deployment to the specified environments.
* @enum {string}
*/
- readonly state: "approved" | "rejected";
+ state: "approved" | "rejected";
/** @description Optional comment to include with the review. */
- readonly comment?: string;
+ comment?: string;
};
/**
* @description The type of reviewer.
* @example User
* @enum {string}
*/
- readonly "deployment-reviewer-type": "User" | "Team";
+ "deployment-reviewer-type": "User" | "Team";
/**
* Pending Deployment
* @description Details of a deployment that is waiting for protection rules to pass
*/
- readonly "pending-deployment": {
- readonly environment: {
+ "pending-deployment": {
+ environment: {
/**
* Format: int64
* @description The id of the environment.
* @example 56780428
*/
- readonly id?: number;
+ id?: number;
/** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- readonly node_id?: string;
+ node_id?: string;
/**
* @description The name of the environment.
* @example staging
*/
- readonly name?: string;
+ name?: string;
/** @example https://api.github.com/repos/github/hello-world/environments/staging */
- readonly url?: string;
+ url?: string;
/** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- readonly html_url?: string;
+ html_url?: string;
};
/**
* @description The set duration of the wait timer
* @example 30
*/
- readonly wait_timer: number;
+ wait_timer: number;
/**
* Format: date-time
* @description The time that the wait timer began.
* @example 2020-11-23T22:00:40Z
*/
- readonly wait_timer_started_at: string | null;
+ wait_timer_started_at: string | null;
/**
* @description Whether the currently authenticated user can approve the deployment
* @example true
*/
- readonly current_user_can_approve: boolean;
+ current_user_can_approve: boolean;
/** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- readonly reviewers: readonly {
- readonly type?: components["schemas"]["deployment-reviewer-type"];
- readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"];
+ reviewers: {
+ type?: components["schemas"]["deployment-reviewer-type"];
+ reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"];
}[];
};
/**
* Deployment
* @description A request for a specific ref(branch,sha,tag) to be deployed
*/
- readonly deployment: {
+ deployment: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/1
*/
- readonly url: string;
+ url: string;
/**
* Format: int64
* @description Unique identifier of the deployment
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOkRlcGxveW1lbnQx */
- readonly node_id: string;
+ node_id: string;
/** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */
- readonly sha: string;
+ sha: string;
/**
* @description The ref to deploy. This can be a branch, tag, or sha.
* @example topic-branch
*/
- readonly ref: string;
+ ref: string;
/**
* @description Parameter to specify a task to execute
* @example deploy
*/
- readonly task: string;
- readonly payload: {
- readonly [key: string]: unknown;
+ task: string;
+ payload: {
+ [key: string]: unknown;
} | string;
/** @example staging */
- readonly original_environment?: string;
+ original_environment?: string;
/**
* @description Name for the target deployment environment.
* @example production
*/
- readonly environment: string;
+ environment: string;
/** @example Deploy request from hubot */
- readonly description: string | null;
- readonly creator: components["schemas"]["nullable-simple-user"];
+ description: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/1/statuses
*/
- readonly statuses_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example
*/
- readonly repository_url: string;
+ repository_url: string;
/**
* @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
* @example true
*/
- readonly transient_environment?: boolean;
+ transient_environment?: boolean;
/**
* @description Specifies if the given environment is one that end-users directly interact with. Default: false.
* @example true
*/
- readonly production_environment?: boolean;
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
+ production_environment?: boolean;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
* Workflow Run Usage
* @description Workflow Run Usage
*/
- readonly "workflow-run-usage": {
- readonly billable: {
- readonly UBUNTU?: {
- readonly total_ms: number;
- readonly jobs: number;
- readonly job_runs?: readonly {
- readonly job_id: number;
- readonly duration_ms: number;
+ "workflow-run-usage": {
+ billable: {
+ UBUNTU?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
}[];
};
- readonly MACOS?: {
- readonly total_ms: number;
- readonly jobs: number;
- readonly job_runs?: readonly {
- readonly job_id: number;
- readonly duration_ms: number;
+ MACOS?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
}[];
};
- readonly WINDOWS?: {
- readonly total_ms: number;
- readonly jobs: number;
- readonly job_runs?: readonly {
- readonly job_id: number;
- readonly duration_ms: number;
+ WINDOWS?: {
+ total_ms: number;
+ jobs: number;
+ job_runs?: {
+ job_id: number;
+ duration_ms: number;
}[];
};
};
- readonly run_duration_ms?: number;
+ run_duration_ms?: number;
};
/**
* Workflow
* @description A GitHub Actions workflow
*/
- readonly workflow: {
+ workflow: {
/** @example 5 */
- readonly id: number;
+ id: number;
/** @example MDg6V29ya2Zsb3cxMg== */
- readonly node_id: string;
+ node_id: string;
/** @example CI */
- readonly name: string;
+ name: string;
/** @example ruby.yaml */
- readonly path: string;
+ path: string;
/**
* @example active
* @enum {string}
*/
- readonly state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually";
+ state: "active" | "deleted" | "disabled_fork" | "disabled_inactivity" | "disabled_manually";
/**
* Format: date-time
* @example 2019-12-06T14:20:20.000Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2019-12-06T14:20:20.000Z
*/
- readonly updated_at: string;
+ updated_at: string;
/** @example https://api.github.com/repos/actions/setup-ruby/workflows/5 */
- readonly url: string;
+ url: string;
/** @example https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml */
- readonly html_url: string;
+ html_url: string;
/** @example https://github.com/actions/setup-ruby/workflows/CI/badge.svg */
- readonly badge_url: string;
+ badge_url: string;
/**
* Format: date-time
* @example 2019-12-06T14:20:20.000Z
*/
- readonly deleted_at?: string;
+ deleted_at?: string;
+ };
+ /**
+ * Workflow Run ID
+ * Format: int64
+ * @description The ID of the workflow run.
+ */
+ "workflow-run-id": number;
+ /**
+ * Workflow Dispatch Response
+ * @description Response containing the workflow run ID and URLs.
+ */
+ "workflow-dispatch-response": {
+ workflow_run_id: components["schemas"]["workflow-run-id"];
+ /**
+ * Format: uri
+ * @description The URL to the workflow run.
+ */
+ run_url: string;
+ /** Format: uri */
+ html_url: string;
};
/**
* Workflow Usage
* @description Workflow Usage
*/
- readonly "workflow-usage": {
- readonly billable: {
- readonly UBUNTU?: {
- readonly total_ms?: number;
+ "workflow-usage": {
+ billable: {
+ UBUNTU?: {
+ total_ms?: number;
};
- readonly MACOS?: {
- readonly total_ms?: number;
+ MACOS?: {
+ total_ms?: number;
};
- readonly WINDOWS?: {
- readonly total_ms?: number;
+ WINDOWS?: {
+ total_ms?: number;
};
};
};
@@ -28236,998 +31319,1020 @@ export type components = {
* Activity
* @description Activity
*/
- readonly activity: {
+ activity: {
/** @example 1296269 */
- readonly id: number;
+ id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The SHA of the commit before the activity.
* @example 6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly before: string;
+ before: string;
/**
* @description The SHA of the commit after the activity.
* @example 827efc6d56897b048c772eb4087f854f46256132
*/
- readonly after: string;
+ after: string;
/**
* @description The full Git reference, formatted as `refs/heads/`.
* @example refs/heads/main
*/
- readonly ref: string;
+ ref: string;
/**
* Format: date-time
* @description The time when the activity occurred.
* @example 2011-01-26T19:06:43Z
*/
- readonly timestamp: string;
+ timestamp: string;
/**
* @description The type of the activity that was performed.
* @example force_push
* @enum {string}
*/
- readonly activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge";
- readonly actor: components["schemas"]["nullable-simple-user"];
+ activity_type: "push" | "force_push" | "branch_deletion" | "branch_creation" | "pr_merge" | "merge_queue_merge";
+ actor: components["schemas"]["nullable-simple-user"];
};
/**
* Autolink reference
* @description An autolink reference.
*/
- readonly autolink: {
+ autolink: {
/** @example 3 */
- readonly id: number;
+ id: number;
/**
* @description The prefix of a key that is linkified.
* @example TICKET-
*/
- readonly key_prefix: string;
+ key_prefix: string;
/**
* @description A template for the target URL that is generated if a key was found.
* @example https://example.com/TICKET?query=
*/
- readonly url_template: string;
+ url_template: string;
/**
* @description Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
* @example true
*/
- readonly is_alphanumeric: boolean;
+ is_alphanumeric: boolean;
+ /** Format: date-time */
+ updated_at?: string | null;
};
/**
* Check Dependabot security updates
* @description Check Dependabot security updates
*/
- readonly "check-automated-security-fixes": {
+ "check-automated-security-fixes": {
/**
* @description Whether Dependabot security updates are enabled for the repository.
* @example true
*/
- readonly enabled: boolean;
+ enabled: boolean;
/**
* @description Whether Dependabot security updates are paused for the repository.
* @example false
*/
- readonly paused: boolean;
+ paused: boolean;
};
/**
* Protected Branch Required Status Check
* @description Protected Branch Required Status Check
*/
- readonly "protected-branch-required-status-check": {
- readonly url?: string;
- readonly enforcement_level?: string;
- readonly contexts: readonly string[];
- readonly checks: readonly {
- readonly context: string;
- readonly app_id: number | null;
+ "protected-branch-required-status-check": {
+ url?: string;
+ enforcement_level?: string;
+ contexts: string[];
+ checks: {
+ context: string;
+ app_id: number | null;
}[];
- readonly contexts_url?: string;
- readonly strict?: boolean;
+ contexts_url?: string;
+ strict?: boolean;
};
/**
* Protected Branch Admin Enforced
* @description Protected Branch Admin Enforced
*/
- readonly "protected-branch-admin-enforced": {
+ "protected-branch-admin-enforced": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins
*/
- readonly url: string;
+ url: string;
/** @example true */
- readonly enabled: boolean;
+ enabled: boolean;
};
/**
* Protected Branch Pull Request Review
* @description Protected Branch Pull Request Review
*/
- readonly "protected-branch-pull-request-review": {
+ "protected-branch-pull-request-review": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
*/
- readonly url?: string;
- readonly dismissal_restrictions?: {
+ url?: string;
+ dismissal_restrictions?: {
/** @description The list of users with review dismissal access. */
- readonly users?: readonly components["schemas"]["simple-user"][];
+ users?: components["schemas"]["simple-user"][];
/** @description The list of teams with review dismissal access. */
- readonly teams?: readonly components["schemas"]["team"][];
+ teams?: components["schemas"]["team"][];
/** @description The list of apps with review dismissal access. */
- readonly apps?: readonly components["schemas"]["integration"][];
+ apps?: components["schemas"]["integration"][];
/** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions" */
- readonly url?: string;
+ url?: string;
/** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users" */
- readonly users_url?: string;
+ users_url?: string;
/** @example "https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams" */
- readonly teams_url?: string;
+ teams_url?: string;
};
/** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- readonly bypass_pull_request_allowances?: {
+ bypass_pull_request_allowances?: {
/** @description The list of users allowed to bypass pull request requirements. */
- readonly users?: readonly components["schemas"]["simple-user"][];
+ users?: components["schemas"]["simple-user"][];
/** @description The list of teams allowed to bypass pull request requirements. */
- readonly teams?: readonly components["schemas"]["team"][];
+ teams?: components["schemas"]["team"][];
/** @description The list of apps allowed to bypass pull request requirements. */
- readonly apps?: readonly components["schemas"]["integration"][];
+ apps?: components["schemas"]["integration"][];
};
/** @example true */
- readonly dismiss_stale_reviews: boolean;
+ dismiss_stale_reviews: boolean;
/** @example true */
- readonly require_code_owner_reviews: boolean;
+ require_code_owner_reviews: boolean;
/** @example 2 */
- readonly required_approving_review_count?: number;
+ required_approving_review_count?: number;
/**
* @description Whether the most recent push must be approved by someone other than the person who pushed it.
* @default false
* @example true
*/
- readonly require_last_push_approval: boolean;
+ require_last_push_approval: boolean;
};
/**
* Branch Restriction Policy
* @description Branch Restriction Policy
*/
- readonly "branch-restriction-policy": {
+ "branch-restriction-policy": {
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly users_url: string;
+ users_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri */
- readonly apps_url: string;
- readonly users: readonly {
- readonly login?: string;
+ apps_url: string;
+ users: {
+ login?: string;
/** Format: int64 */
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- readonly user_view_type?: string;
- }[];
- readonly teams: readonly {
- readonly id?: number;
- readonly node_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly name?: string;
- readonly slug?: string;
- readonly description?: string | null;
- readonly privacy?: string;
- readonly notification_setting?: string;
- readonly permission?: string;
- readonly members_url?: string;
- readonly repositories_url?: string;
- readonly parent?: string | null;
+ 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;
+ user_view_type?: string;
}[];
- readonly apps: readonly {
- readonly id?: number;
- readonly slug?: string;
- readonly node_id?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly hooks_url?: string;
- readonly issues_url?: string;
- readonly members_url?: string;
- readonly public_members_url?: string;
- readonly avatar_url?: string;
- readonly description?: string;
+ teams: components["schemas"]["team"][];
+ apps: {
+ id?: number;
+ slug?: string;
+ node_id?: string;
+ owner?: {
+ login?: string;
+ id?: number;
+ node_id?: string;
+ url?: string;
+ repos_url?: string;
+ events_url?: string;
+ hooks_url?: string;
+ issues_url?: string;
+ members_url?: string;
+ public_members_url?: string;
+ avatar_url?: string;
+ description?: string;
/** @example "" */
- readonly gravatar_id?: string;
+ gravatar_id?: string;
/** @example "https://github.com/testorg-ea8ec76d71c3af4b" */
- readonly html_url?: string;
+ html_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers" */
- readonly followers_url?: string;
+ followers_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}" */
- readonly following_url?: string;
+ following_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}" */
- readonly gists_url?: string;
+ gists_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}" */
- readonly starred_url?: string;
+ starred_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions" */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs" */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** @example "https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events" */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** @example "Organization" */
- readonly type?: string;
+ type?: string;
/** @example false */
- readonly site_admin?: boolean;
+ site_admin?: boolean;
/** @example public */
- readonly user_view_type?: string;
- };
- readonly name?: string;
- readonly client_id?: string;
- readonly description?: string;
- readonly external_url?: string;
- readonly html_url?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly metadata?: string;
- readonly contents?: string;
- readonly issues?: string;
- readonly single_file?: string;
- };
- readonly events?: readonly string[];
+ user_view_type?: string;
+ };
+ name?: string;
+ client_id?: string;
+ description?: string;
+ external_url?: string;
+ html_url?: string;
+ created_at?: string;
+ updated_at?: string;
+ permissions?: {
+ metadata?: string;
+ contents?: string;
+ issues?: string;
+ single_file?: string;
+ };
+ events?: string[];
}[];
};
/**
* Branch Protection
* @description Branch Protection
*/
- readonly "branch-protection": {
- readonly url?: string;
- readonly enabled?: boolean;
- readonly required_status_checks?: components["schemas"]["protected-branch-required-status-check"];
- readonly enforce_admins?: components["schemas"]["protected-branch-admin-enforced"];
- readonly required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"];
- readonly restrictions?: components["schemas"]["branch-restriction-policy"];
- readonly required_linear_history?: {
- readonly enabled?: boolean;
+ "branch-protection": {
+ url?: string;
+ enabled?: boolean;
+ required_status_checks?: components["schemas"]["protected-branch-required-status-check"];
+ enforce_admins?: components["schemas"]["protected-branch-admin-enforced"];
+ required_pull_request_reviews?: components["schemas"]["protected-branch-pull-request-review"];
+ restrictions?: components["schemas"]["branch-restriction-policy"];
+ required_linear_history?: {
+ enabled?: boolean;
};
- readonly allow_force_pushes?: {
- readonly enabled?: boolean;
+ allow_force_pushes?: {
+ enabled?: boolean;
};
- readonly allow_deletions?: {
- readonly enabled?: boolean;
+ allow_deletions?: {
+ enabled?: boolean;
};
- readonly block_creations?: {
- readonly enabled?: boolean;
+ block_creations?: {
+ enabled?: boolean;
};
- readonly required_conversation_resolution?: {
- readonly enabled?: boolean;
+ required_conversation_resolution?: {
+ enabled?: boolean;
};
/** @example "branch/with/protection" */
- readonly name?: string;
+ name?: string;
/** @example "https://api.github.com/repos/owner-79e94e2d36b3fd06a32bb213/AAA_Public_Repo/branches/branch/with/protection/protection" */
- readonly protection_url?: string;
- readonly required_signatures?: {
+ protection_url?: string;
+ required_signatures?: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
*/
- readonly url: string;
+ url: string;
/** @example true */
- readonly enabled: boolean;
+ enabled: boolean;
};
/** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */
- readonly lock_branch?: {
+ lock_branch?: {
/** @default false */
- readonly enabled: boolean;
+ enabled: boolean;
};
/** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */
- readonly allow_fork_syncing?: {
+ allow_fork_syncing?: {
/** @default false */
- readonly enabled: boolean;
+ enabled: boolean;
};
};
/**
* Short Branch
* @description Short Branch
*/
- readonly "short-branch": {
- readonly name: string;
- readonly commit: {
- readonly sha: string;
+ "short-branch": {
+ name: string;
+ commit: {
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly protected: boolean;
- readonly protection?: components["schemas"]["branch-protection"];
+ protected: boolean;
+ protection?: components["schemas"]["branch-protection"];
/** Format: uri */
- readonly protection_url?: string;
+ protection_url?: string;
};
/**
* Git User
* @description Metaproperties for Git author/committer information.
*/
- readonly "nullable-git-user": {
+ "nullable-git-user": {
/** @example "Chris Wanstrath" */
- readonly name?: string;
+ name?: string;
/** @example "chris@ozmm.org" */
- readonly email?: string;
- /** @example "2007-10-29T02:42:39.000-07:00" */
- readonly date?: string;
+ email?: string;
+ /**
+ * Format: date-time
+ * @example "2007-10-29T02:42:39.000-07:00"
+ */
+ date?: string;
} | null;
/** Verification */
- readonly verification: {
- readonly verified: boolean;
- readonly reason: string;
- readonly payload: string | null;
- readonly signature: string | null;
- readonly verified_at?: string | null;
+ verification: {
+ verified: boolean;
+ reason: string;
+ payload: string | null;
+ signature: string | null;
+ verified_at: string | null;
};
/**
* Diff Entry
* @description Diff Entry
*/
- readonly "diff-entry": {
+ "diff-entry": {
/** @example bbcd538c8e72b8c175046e27cc8f907076331401 */
- readonly sha: string;
+ sha: string | null;
/** @example file1.txt */
- readonly filename: string;
+ filename: string;
/**
* @example added
* @enum {string}
*/
- readonly status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
+ status: "added" | "removed" | "modified" | "renamed" | "copied" | "changed" | "unchanged";
/** @example 103 */
- readonly additions: number;
+ additions: number;
/** @example 21 */
- readonly deletions: number;
+ deletions: number;
/** @example 124 */
- readonly changes: number;
+ changes: number;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
*/
- readonly blob_url: string;
+ blob_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt
*/
- readonly raw_url: string;
+ raw_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly contents_url: string;
+ contents_url: string;
/** @example @@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test */
- readonly patch?: string;
+ patch?: string;
/** @example file.txt */
- readonly previous_filename?: string;
+ previous_filename?: string;
};
/**
* Commit
* @description Commit
*/
- readonly commit: {
+ commit: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly url: string;
+ url: string;
/** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
- readonly sha: string;
+ sha: string;
/** @example MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments
*/
- readonly comments_url: string;
- readonly commit: {
+ comments_url: string;
+ commit: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly url: string;
- readonly author: components["schemas"]["nullable-git-user"];
- readonly committer: components["schemas"]["nullable-git-user"];
+ url: string;
+ author: components["schemas"]["nullable-git-user"];
+ committer: components["schemas"]["nullable-git-user"];
/** @example Fix all the bugs */
- readonly message: string;
+ message: string;
/** @example 0 */
- readonly comment_count: number;
- readonly tree: {
+ comment_count: number;
+ tree: {
/** @example 827efc6d56897b048c772eb4087f854f46256132 */
- readonly sha: string;
+ sha: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/tree/827efc6d56897b048c772eb4087f854f46256132
*/
- readonly url: string;
+ url: string;
};
- readonly verification?: components["schemas"]["verification"];
+ verification?: components["schemas"]["verification"];
};
- readonly author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null;
- readonly committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null;
- readonly parents: readonly {
+ author: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null;
+ committer: (components["schemas"]["simple-user"] | components["schemas"]["empty-object"]) | null;
+ parents: {
/** @example 7638417db6d59f3c431d3e1f261cc637155684cd */
- readonly sha: string;
+ sha: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly html_url?: string;
+ html_url?: string;
}[];
- readonly stats?: {
- readonly additions?: number;
- readonly deletions?: number;
- readonly total?: number;
+ stats?: {
+ additions?: number;
+ deletions?: number;
+ total?: number;
};
- readonly files?: readonly components["schemas"]["diff-entry"][];
+ files?: components["schemas"]["diff-entry"][];
};
/**
* Branch With Protection
* @description Branch With Protection
*/
- readonly "branch-with-protection": {
- readonly name: string;
- readonly commit: components["schemas"]["commit"];
- readonly _links: {
- readonly html: string;
+ "branch-with-protection": {
+ name: string;
+ commit: components["schemas"]["commit"];
+ _links: {
+ html: string;
/** Format: uri */
- readonly self: string;
+ self: string;
};
- readonly protected: boolean;
- readonly protection: components["schemas"]["branch-protection"];
+ protected: boolean;
+ protection: components["schemas"]["branch-protection"];
/** Format: uri */
- readonly protection_url: string;
+ protection_url: string;
/** @example "mas*" */
- readonly pattern?: string;
+ pattern?: string;
/** @example 1 */
- readonly required_approving_review_count?: number;
+ required_approving_review_count?: number;
};
/**
* Status Check Policy
* @description Status Check Policy
*/
- readonly "status-check-policy": {
+ "status-check-policy": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
*/
- readonly url: string;
+ url: string;
/** @example true */
- readonly strict: boolean;
+ strict: boolean;
/**
* @example [
* "continuous-integration/travis-ci"
* ]
*/
- readonly contexts: readonly string[];
- readonly checks: readonly {
+ contexts: string[];
+ checks: {
/** @example continuous-integration/travis-ci */
- readonly context: string;
- readonly app_id: number | null;
+ context: string;
+ app_id: number | null;
}[];
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
*/
- readonly contexts_url: string;
+ contexts_url: string;
};
/**
* Protected Branch
* @description Branch protections protect branches
*/
- readonly "protected-branch": {
+ "protected-branch": {
/** Format: uri */
- readonly url: string;
- readonly required_status_checks?: components["schemas"]["status-check-policy"];
- readonly required_pull_request_reviews?: {
- /** Format: uri */
- readonly url: string;
- readonly dismiss_stale_reviews?: boolean;
- readonly require_code_owner_reviews?: boolean;
- readonly required_approving_review_count?: number;
+ url: string;
+ required_status_checks?: components["schemas"]["status-check-policy"];
+ required_pull_request_reviews?: {
+ /** Format: uri */
+ url: string;
+ dismiss_stale_reviews?: boolean;
+ require_code_owner_reviews?: boolean;
+ required_approving_review_count?: number;
/**
* @description Whether the most recent push must be approved by someone other than the person who pushed it.
* @default false
*/
- readonly require_last_push_approval: boolean;
- readonly dismissal_restrictions?: {
+ require_last_push_approval: boolean;
+ dismissal_restrictions?: {
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly users_url: string;
+ users_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly users: readonly components["schemas"]["simple-user"][];
- readonly teams: readonly components["schemas"]["team"][];
- readonly apps?: readonly components["schemas"]["integration"][];
+ teams_url: string;
+ users: components["schemas"]["simple-user"][];
+ teams: components["schemas"]["team"][];
+ apps?: components["schemas"]["integration"][];
};
- readonly bypass_pull_request_allowances?: {
- readonly users: readonly components["schemas"]["simple-user"][];
- readonly teams: readonly components["schemas"]["team"][];
- readonly apps?: readonly components["schemas"]["integration"][];
+ bypass_pull_request_allowances?: {
+ users: components["schemas"]["simple-user"][];
+ teams: components["schemas"]["team"][];
+ apps?: components["schemas"]["integration"][];
};
};
- readonly required_signatures?: {
+ required_signatures?: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
*/
- readonly url: string;
+ url: string;
/** @example true */
- readonly enabled: boolean;
+ enabled: boolean;
};
- readonly enforce_admins?: {
+ enforce_admins?: {
/** Format: uri */
- readonly url: string;
- readonly enabled: boolean;
+ url: string;
+ enabled: boolean;
};
- readonly required_linear_history?: {
- readonly enabled: boolean;
+ required_linear_history?: {
+ enabled: boolean;
};
- readonly allow_force_pushes?: {
- readonly enabled: boolean;
+ allow_force_pushes?: {
+ enabled: boolean;
};
- readonly allow_deletions?: {
- readonly enabled: boolean;
+ allow_deletions?: {
+ enabled: boolean;
};
- readonly restrictions?: components["schemas"]["branch-restriction-policy"];
- readonly required_conversation_resolution?: {
- readonly enabled?: boolean;
+ restrictions?: components["schemas"]["branch-restriction-policy"];
+ required_conversation_resolution?: {
+ enabled?: boolean;
};
- readonly block_creations?: {
- readonly enabled: boolean;
+ block_creations?: {
+ enabled: boolean;
};
/** @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. */
- readonly lock_branch?: {
+ lock_branch?: {
/** @default false */
- readonly enabled: boolean;
+ enabled: boolean;
};
/** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. */
- readonly allow_fork_syncing?: {
+ allow_fork_syncing?: {
/** @default false */
- readonly enabled: boolean;
+ enabled: boolean;
};
};
/**
* Deployment
* @description A deployment created as the result of an Actions check run from a workflow that references an environment
*/
- readonly "deployment-simple": {
+ "deployment-simple": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/1
*/
- readonly url: string;
+ url: string;
/**
* @description Unique identifier of the deployment
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOkRlcGxveW1lbnQx */
- readonly node_id: string;
+ node_id: string;
/**
* @description Parameter to specify a task to execute
* @example deploy
*/
- readonly task: string;
+ task: string;
/** @example staging */
- readonly original_environment?: string;
+ original_environment?: string;
/**
* @description Name for the target deployment environment.
* @example production
*/
- readonly environment: string;
+ environment: string;
/** @example Deploy request from hubot */
- readonly description: string | null;
+ description: string | null;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/1/statuses
*/
- readonly statuses_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example
*/
- readonly repository_url: string;
+ repository_url: string;
/**
* @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
* @example true
*/
- readonly transient_environment?: boolean;
+ transient_environment?: boolean;
/**
* @description Specifies if the given environment is one that end-users directly interact with. Default: false.
* @example true
*/
- readonly production_environment?: boolean;
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
+ production_environment?: boolean;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
* CheckRun
* @description A check performed on the code of a given code change
*/
- readonly "check-run": {
+ "check-run": {
/**
* Format: int64
* @description The id of the check.
* @example 21
*/
- readonly id: number;
+ id: number;
/**
* @description The SHA of the commit that is being checked.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha: string;
+ head_sha: string;
/** @example MDg6Q2hlY2tSdW40 */
- readonly node_id: string;
+ node_id: string;
/** @example 42 */
- readonly external_id: string | null;
+ external_id: string | null;
/** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- readonly url: string;
+ url: string;
/** @example https://github.com/github/hello-world/runs/4 */
- readonly html_url: string | null;
+ html_url: string | null;
/** @example https://example.com */
- readonly details_url: string | null;
+ details_url: string | null;
/**
* @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @example neutral
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
/**
* Format: date-time
* @example 2018-05-04T01:14:52Z
*/
- readonly started_at: string | null;
+ started_at: string | null;
/**
* Format: date-time
* @example 2018-05-04T01:14:52Z
*/
- readonly completed_at: string | null;
- readonly output: {
- readonly title: string | null;
- readonly summary: string | null;
- readonly text: string | null;
- readonly annotations_count: number;
+ completed_at: string | null;
+ output: {
+ title: string | null;
+ summary: string | null;
+ text: string | null;
+ annotations_count: number;
/** Format: uri */
- readonly annotations_url: string;
+ annotations_url: string;
};
/**
* @description The name of the check.
* @example test-coverage
*/
- readonly name: string;
- readonly check_suite: {
- readonly id: number;
+ name: string;
+ check_suite: {
+ id: number;
} | null;
- readonly app: components["schemas"]["nullable-integration"];
+ app: components["schemas"]["nullable-integration"];
/** @description Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. */
- readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][];
- readonly deployment?: components["schemas"]["deployment-simple"];
+ pull_requests: components["schemas"]["pull-request-minimal"][];
+ deployment?: components["schemas"]["deployment-simple"];
};
/**
* Check Annotation
* @description Check Annotation
*/
- readonly "check-annotation": {
+ "check-annotation": {
/** @example README.md */
- readonly path: string;
+ path: string;
/** @example 2 */
- readonly start_line: number;
+ start_line: number;
/** @example 2 */
- readonly end_line: number;
+ end_line: number;
/** @example 5 */
- readonly start_column: number | null;
+ start_column: number | null;
/** @example 10 */
- readonly end_column: number | null;
+ end_column: number | null;
/** @example warning */
- readonly annotation_level: string | null;
+ annotation_level: string | null;
/** @example Spell Checker */
- readonly title: string | null;
+ title: string | null;
/** @example Check your spelling for 'banaas'. */
- readonly message: string | null;
+ message: string | null;
/** @example Do you mean 'bananas' or 'banana'? */
- readonly raw_details: string | null;
- readonly blob_href: string;
+ raw_details: string | null;
+ blob_href: string;
};
/**
* Simple Commit
* @description A commit.
*/
- readonly "simple-commit": {
+ "simple-commit": {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly id: string;
+ id: string;
/** @description SHA for the commit's tree */
- readonly tree_id: string;
+ tree_id: string;
/**
* @description Message describing the purpose of the commit
* @example Fix #42
*/
- readonly message: string;
+ message: string;
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly timestamp: string;
+ timestamp: string;
/** @description Information about the Git author */
- readonly author: {
+ author: {
/**
* @description Name of the commit's author
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
/**
* Format: email
* @description Git email address of the commit's author
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
} | null;
/** @description Information about the Git committer */
- readonly committer: {
+ committer: {
/**
* @description Name of the commit's committer
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
/**
* Format: email
* @description Git email address of the commit's committer
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
} | null;
};
/**
* CheckSuite
* @description A suite of checks performed on the code of a given code change
*/
- readonly "check-suite": {
+ "check-suite": {
/**
* Format: int64
* @example 5
*/
- readonly id: number;
+ id: number;
/** @example MDEwOkNoZWNrU3VpdGU1 */
- readonly node_id: string;
+ node_id: string;
/** @example master */
- readonly head_branch: string | null;
+ head_branch: string | null;
/**
* @description The SHA of the head commit that is being checked.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha: string;
+ head_sha: string;
/**
* @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.
* @example completed
* @enum {string|null}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null;
+ status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null;
/**
* @example neutral
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null;
/** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
- readonly url: string | null;
+ url: string | null;
/** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
- readonly before: string | null;
+ before: string | null;
/** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
- readonly after: string | null;
- readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][] | null;
- readonly app: components["schemas"]["nullable-integration"];
- readonly repository: components["schemas"]["minimal-repository"];
+ after: string | null;
+ pull_requests: components["schemas"]["pull-request-minimal"][] | null;
+ app: components["schemas"]["nullable-integration"];
+ repository: components["schemas"]["minimal-repository"];
/** Format: date-time */
- readonly created_at: string | null;
+ created_at: string | null;
/** Format: date-time */
- readonly updated_at: string | null;
- readonly head_commit: components["schemas"]["simple-commit"];
- readonly latest_check_runs_count: number;
- readonly check_runs_url: string;
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
+ updated_at: string | null;
+ head_commit: components["schemas"]["simple-commit"];
+ latest_check_runs_count: number;
+ check_runs_url: string;
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
};
/**
* Check Suite Preference
* @description Check suite configuration preferences for a repository.
*/
- readonly "check-suite-preference": {
- readonly preferences: {
- readonly auto_trigger_checks?: readonly {
- readonly app_id: number;
- readonly setting: boolean;
+ "check-suite-preference": {
+ preferences: {
+ auto_trigger_checks?: {
+ app_id: number;
+ setting: boolean;
}[];
};
- readonly repository: components["schemas"]["minimal-repository"];
- };
- readonly "code-scanning-alert-items": {
- readonly number: components["schemas"]["alert-number"];
- readonly created_at: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["alert-updated-at"];
- readonly url: components["schemas"]["alert-url"];
- readonly html_url: components["schemas"]["alert-html-url"];
- readonly instances_url: components["schemas"]["alert-instances-url"];
- readonly state: components["schemas"]["code-scanning-alert-state"];
- readonly fixed_at?: components["schemas"]["alert-fixed-at"];
- readonly dismissed_by: components["schemas"]["nullable-simple-user"];
- readonly dismissed_at: components["schemas"]["alert-dismissed-at"];
- readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- readonly rule: components["schemas"]["code-scanning-alert-rule-summary"];
- readonly tool: components["schemas"]["code-scanning-analysis-tool"];
- readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
- };
- readonly "code-scanning-alert-rule": {
+ repository: components["schemas"]["minimal-repository"];
+ };
+ "code-scanning-alert-items": {
+ number: components["schemas"]["alert-number"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["alert-updated-at"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ instances_url: components["schemas"]["alert-instances-url"];
+ state: components["schemas"]["code-scanning-alert-state"];
+ fixed_at?: components["schemas"]["alert-fixed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ rule: components["schemas"]["code-scanning-alert-rule-summary"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ dismissal_approved_by?: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][];
+ };
+ "code-scanning-alert-rule": {
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id?: string | null;
+ id?: string | null;
/** @description The name of the rule used to detect the alert. */
- readonly name?: string;
+ name?: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity?: "none" | "note" | "warning" | "error" | null;
+ severity?: "none" | "note" | "warning" | "error" | null;
/**
* @description The security severity of the alert.
* @enum {string|null}
*/
- readonly security_severity_level?: "low" | "medium" | "high" | "critical" | null;
+ security_severity_level?: "low" | "medium" | "high" | "critical" | null;
/** @description A short description of the rule used to detect the alert. */
- readonly description?: string;
+ description?: string;
/** @description A description of the rule used to detect the alert. */
- readonly full_description?: string;
+ full_description?: string;
/** @description A set of tags applicable for the rule. */
- readonly tags?: readonly string[] | null;
+ tags?: string[] | null;
/** @description Detailed documentation for the rule as GitHub Flavored Markdown. */
- readonly help?: string | null;
+ help?: string | null;
/** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
- };
- readonly "code-scanning-alert": {
- readonly number: components["schemas"]["alert-number"];
- readonly created_at: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["alert-updated-at"];
- readonly url: components["schemas"]["alert-url"];
- readonly html_url: components["schemas"]["alert-html-url"];
- readonly instances_url: components["schemas"]["alert-instances-url"];
- readonly state: components["schemas"]["code-scanning-alert-state"];
- readonly fixed_at?: components["schemas"]["alert-fixed-at"];
- readonly dismissed_by: components["schemas"]["nullable-simple-user"];
- readonly dismissed_at: components["schemas"]["alert-dismissed-at"];
- readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- readonly rule: components["schemas"]["code-scanning-alert-rule"];
- readonly tool: components["schemas"]["code-scanning-analysis-tool"];
- readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ help_uri?: string | null;
+ };
+ "code-scanning-alert": {
+ number: components["schemas"]["alert-number"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["alert-updated-at"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ instances_url: components["schemas"]["alert-instances-url"];
+ state: components["schemas"]["code-scanning-alert-state"];
+ fixed_at?: components["schemas"]["alert-fixed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ rule: components["schemas"]["code-scanning-alert-rule"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ most_recent_instance: components["schemas"]["code-scanning-alert-instance"];
+ dismissal_approved_by?: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][];
};
/**
* @description Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
* @enum {string}
*/
- readonly "code-scanning-alert-set-state": "open" | "dismissed";
+ "code-scanning-alert-set-state": "open" | "dismissed";
+ /** @description If `true`, attempt to create an alert dismissal request. */
+ "code-scanning-alert-create-request": boolean;
+ /** @description The list of users to assign to the code scanning alert. An empty array unassigns all previous assignees from the alert. */
+ "code-scanning-alert-assignees": string[];
/**
* @description The status of an autofix.
* @enum {string}
*/
- readonly "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated";
+ "code-scanning-autofix-status": "pending" | "error" | "success" | "outdated";
/** @description The description of an autofix. */
- readonly "code-scanning-autofix-description": string | null;
+ "code-scanning-autofix-description": string | null;
/**
* Format: date-time
* @description The start time of an autofix in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly "code-scanning-autofix-started-at": string;
- readonly "code-scanning-autofix": {
- readonly status: components["schemas"]["code-scanning-autofix-status"];
- readonly description: components["schemas"]["code-scanning-autofix-description"];
- readonly started_at: components["schemas"]["code-scanning-autofix-started-at"];
+ "code-scanning-autofix-started-at": string;
+ "code-scanning-autofix": {
+ status: components["schemas"]["code-scanning-autofix-status"];
+ description: components["schemas"]["code-scanning-autofix-description"];
+ started_at: components["schemas"]["code-scanning-autofix-started-at"];
};
/** @description Commit an autofix for a code scanning alert */
- readonly "code-scanning-autofix-commits": {
+ "code-scanning-autofix-commits": {
/** @description The Git reference of target branch for the commit. Branch needs to already exist. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly target_ref?: string;
+ target_ref?: string;
/** @description Commit message to be used. */
- readonly message?: string;
+ message?: string;
} | null;
- readonly "code-scanning-autofix-commits-response": {
+ "code-scanning-autofix-commits-response": {
/** @description The Git reference of target branch for the commit. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly target_ref?: string;
+ target_ref?: string;
/** @description SHA of commit with autofix. */
- readonly sha?: string;
+ sha?: string;
+ };
+ /**
+ * @description State of a code scanning alert instance.
+ * @enum {string|null}
+ */
+ "code-scanning-alert-instance-state": "open" | "fixed" | null;
+ "code-scanning-alert-instance-list": {
+ ref?: components["schemas"]["code-scanning-ref"];
+ analysis_key?: components["schemas"]["code-scanning-analysis-analysis-key"];
+ environment?: components["schemas"]["code-scanning-alert-environment"];
+ category?: components["schemas"]["code-scanning-analysis-category"];
+ state?: components["schemas"]["code-scanning-alert-instance-state"];
+ commit_sha?: string;
+ message?: {
+ text?: string;
+ };
+ location?: components["schemas"]["code-scanning-alert-location"];
+ html_url?: string;
+ /**
+ * @description Classifications that have been applied to the file that triggered the alert.
+ * For example identifying it as documentation, or a generated file.
+ */
+ classifications?: components["schemas"]["code-scanning-alert-classification"][];
};
/**
* @description An identifier for the upload.
* @example 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53
*/
- readonly "code-scanning-analysis-sarif-id": string;
+ "code-scanning-analysis-sarif-id": string;
/** @description The SHA of the commit to which the analysis you are uploading relates. */
- readonly "code-scanning-analysis-commit-sha": string;
+ "code-scanning-analysis-commit-sha": string;
/** @description Identifies the variable values associated with the environment in which this analysis was performed. */
- readonly "code-scanning-analysis-environment": string;
+ "code-scanning-analysis-environment": string;
/**
* Format: date-time
* @description The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly "code-scanning-analysis-created-at": string;
+ "code-scanning-analysis-created-at": string;
/**
* Format: uri
* @description The REST API URL of the analysis resource.
*/
- readonly "code-scanning-analysis-url": string;
- readonly "code-scanning-analysis": {
- readonly ref: components["schemas"]["code-scanning-ref"];
- readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
- readonly analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"];
- readonly environment: components["schemas"]["code-scanning-analysis-environment"];
- readonly category?: components["schemas"]["code-scanning-analysis-category"];
+ "code-scanning-analysis-url": string;
+ "code-scanning-analysis": {
+ ref: components["schemas"]["code-scanning-ref"];
+ commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
+ analysis_key: components["schemas"]["code-scanning-analysis-analysis-key"];
+ environment: components["schemas"]["code-scanning-analysis-environment"];
+ category?: components["schemas"]["code-scanning-analysis-category"];
/** @example error reading field xyz */
- readonly error: string;
- readonly created_at: components["schemas"]["code-scanning-analysis-created-at"];
+ error: string;
+ created_at: components["schemas"]["code-scanning-analysis-created-at"];
/** @description The total number of results in the analysis. */
- readonly results_count: number;
+ results_count: number;
/** @description The total number of rules used in the analysis. */
- readonly rules_count: number;
+ rules_count: number;
/** @description Unique identifier for this analysis. */
- readonly id: number;
- readonly url: components["schemas"]["code-scanning-analysis-url"];
- readonly sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"];
- readonly tool: components["schemas"]["code-scanning-analysis-tool"];
- readonly deletable: boolean;
+ id: number;
+ url: components["schemas"]["code-scanning-analysis-url"];
+ sarif_id: components["schemas"]["code-scanning-analysis-sarif-id"];
+ tool: components["schemas"]["code-scanning-analysis-tool"];
+ deletable: boolean;
/**
* @description Warning generated when processing the analysis
* @example 123 results were ignored
*/
- readonly warning: string;
+ warning: string;
};
/**
* Analysis deletion
* @description Successful deletion of a code scanning analysis
*/
- readonly "code-scanning-analysis-deletion": {
+ "code-scanning-analysis-deletion": {
/**
* Format: uri
* @description Next deletable analysis in chain, without last analysis deletion confirmation
@@ -29243,304 +32348,314 @@ export type components = {
* CodeQL Database
* @description A CodeQL database.
*/
- readonly "code-scanning-codeql-database": {
+ "code-scanning-codeql-database": {
/** @description The ID of the CodeQL database. */
- readonly id: number;
+ id: number;
/** @description The name of the CodeQL database. */
- readonly name: string;
+ name: string;
/** @description The language of the CodeQL database. */
- readonly language: string;
- readonly uploader: components["schemas"]["simple-user"];
+ language: string;
+ uploader: components["schemas"]["simple-user"];
/** @description The MIME type of the CodeQL database file. */
- readonly content_type: string;
+ content_type: string;
/** @description The size of the CodeQL database file in bytes. */
- readonly size: number;
+ size: number;
/**
* Format: date-time
* @description The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property.
*/
- readonly url: string;
+ url: string;
/** @description The commit SHA of the repository at the time the CodeQL database was created. */
- readonly commit_oid?: string | null;
+ commit_oid?: string | null;
};
/**
* @description The language targeted by the CodeQL query
* @enum {string}
*/
- readonly "code-scanning-variant-analysis-language": "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "swift";
+ "code-scanning-variant-analysis-language": "actions" | "cpp" | "csharp" | "go" | "java" | "javascript" | "python" | "ruby" | "rust" | "swift";
/**
* Repository Identifier
* @description Repository Identifier
*/
- readonly "code-scanning-variant-analysis-repository": {
+ "code-scanning-variant-analysis-repository": {
/**
* @description A unique identifier of the repository.
* @example 1296269
*/
- readonly id: number;
+ id: number;
/**
* @description The name of the repository.
* @example Hello-World
*/
- readonly name: string;
+ name: string;
/**
* @description The full, globally unique, name of the repository.
* @example octocat/Hello-World
*/
- readonly full_name: string;
+ full_name: string;
/** @description Whether the repository is private. */
- readonly private: boolean;
+ private: boolean;
/** @example 80 */
- readonly stargazers_count: number;
+ stargazers_count: number;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
};
/**
* @description The new status of the CodeQL variant analysis repository task.
* @enum {string}
*/
- readonly "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out";
- readonly "code-scanning-variant-analysis-skipped-repo-group": {
+ "code-scanning-variant-analysis-status": "pending" | "in_progress" | "succeeded" | "failed" | "canceled" | "timed_out";
+ "code-scanning-variant-analysis-skipped-repo-group": {
/**
* @description The total number of repositories that were skipped for this reason.
* @example 2
*/
- readonly repository_count: number;
+ repository_count: number;
/** @description A list of repositories that were skipped. This list may not include all repositories that were skipped. This is only available when the repository was found and the user has access to it. */
- readonly repositories: readonly components["schemas"]["code-scanning-variant-analysis-repository"][];
+ repositories: components["schemas"]["code-scanning-variant-analysis-repository"][];
};
/**
* Variant Analysis
* @description A run of a CodeQL query against one or more repositories.
*/
- readonly "code-scanning-variant-analysis": {
+ "code-scanning-variant-analysis": {
/** @description The ID of the variant analysis. */
- readonly id: number;
- readonly controller_repo: components["schemas"]["simple-repository"];
- readonly actor: components["schemas"]["simple-user"];
- readonly query_language: components["schemas"]["code-scanning-variant-analysis-language"];
+ id: number;
+ controller_repo: components["schemas"]["simple-repository"];
+ actor: components["schemas"]["simple-user"];
+ query_language: components["schemas"]["code-scanning-variant-analysis-language"];
/** @description The download url for the query pack. */
- readonly query_pack_url: string;
+ query_pack_url: string;
/**
* Format: date-time
* @description The date and time at which the variant analysis was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly created_at?: string;
+ created_at?: string;
/**
* Format: date-time
* @description The date and time at which the variant analysis was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly updated_at?: string;
+ updated_at?: string;
/**
* Format: date-time
* @description The date and time at which the variant analysis was completed, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ. Will be null if the variant analysis has not yet completed or this information is not available.
*/
- readonly completed_at?: string | null;
+ completed_at?: string | null;
/** @enum {string} */
- readonly status: "in_progress" | "succeeded" | "failed" | "cancelled";
+ status: "in_progress" | "succeeded" | "failed" | "cancelled";
/** @description The GitHub Actions workflow run used to execute this variant analysis. This is only available if the workflow run has started. */
- readonly actions_workflow_run_id?: number;
+ actions_workflow_run_id?: number;
/**
* @description The reason for a failure of the variant analysis. This is only available if the variant analysis has failed.
* @enum {string}
*/
- readonly failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error";
- readonly scanned_repositories?: readonly {
- readonly repository: components["schemas"]["code-scanning-variant-analysis-repository"];
- readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"];
+ failure_reason?: "no_repos_queried" | "actions_workflow_run_failed" | "internal_error";
+ scanned_repositories?: {
+ repository: components["schemas"]["code-scanning-variant-analysis-repository"];
+ analysis_status: components["schemas"]["code-scanning-variant-analysis-status"];
/** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */
- readonly result_count?: number;
+ result_count?: number;
/** @description The size of the artifact. This is only available for successful analyses. */
- readonly artifact_size_in_bytes?: number;
+ artifact_size_in_bytes?: number;
/** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */
- readonly failure_message?: string;
+ failure_message?: string;
}[];
/** @description Information about repositories that were skipped from processing. This information is only available to the user that initiated the variant analysis. */
- readonly skipped_repositories?: {
- readonly access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
- readonly not_found_repos: {
+ skipped_repositories?: {
+ access_mismatch_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
+ not_found_repos: {
/**
* @description The total number of repositories that were skipped for this reason.
* @example 2
*/
- readonly repository_count: number;
+ repository_count: number;
/** @description A list of full repository names that were skipped. This list may not include all repositories that were skipped. */
- readonly repository_full_names: readonly string[];
+ repository_full_names: string[];
};
- readonly no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
- readonly over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
+ no_codeql_db_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
+ over_limit_repos: components["schemas"]["code-scanning-variant-analysis-skipped-repo-group"];
};
};
- readonly "code-scanning-variant-analysis-repo-task": {
- readonly repository: components["schemas"]["simple-repository"];
- readonly analysis_status: components["schemas"]["code-scanning-variant-analysis-status"];
+ "code-scanning-variant-analysis-repo-task": {
+ repository: components["schemas"]["simple-repository"];
+ analysis_status: components["schemas"]["code-scanning-variant-analysis-status"];
/** @description The size of the artifact. This is only available for successful analyses. */
- readonly artifact_size_in_bytes?: number;
+ artifact_size_in_bytes?: number;
/** @description The number of results in the case of a successful analysis. This is only available for successful analyses. */
- readonly result_count?: number;
+ result_count?: number;
/** @description The reason of the failure of this repo task. This is only available if the repository task has failed. */
- readonly failure_message?: string;
+ failure_message?: string;
/** @description The SHA of the commit the CodeQL database was built against. This is only available for successful analyses. */
- readonly database_commit_sha?: string;
+ database_commit_sha?: string;
/** @description The source location prefix to use. This is only available for successful analyses. */
- readonly source_location_prefix?: string;
+ source_location_prefix?: string;
/** @description The URL of the artifact. This is only available for successful analyses. */
- readonly artifact_url?: string;
+ artifact_url?: string;
};
/** @description Configuration for code scanning default setup. */
- readonly "code-scanning-default-setup": {
+ "code-scanning-default-setup": {
/**
* @description Code scanning default setup has been configured or not.
* @enum {string}
*/
- readonly state?: "configured" | "not-configured";
+ state?: "configured" | "not-configured";
/** @description Languages to be analyzed. */
- readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[];
+ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "javascript" | "python" | "ruby" | "typescript" | "swift")[];
/**
* @description Runner type to be used.
* @enum {string|null}
*/
- readonly runner_type?: "standard" | "labeled" | null;
+ runner_type?: "standard" | "labeled" | null;
/**
* @description Runner label to be used if the runner type is labeled.
* @example code-scanning
*/
- readonly runner_label?: string | null;
+ runner_label?: string | null;
/**
* @description CodeQL query suite to be used.
* @enum {string}
*/
- readonly query_suite?: "default" | "extended";
+ query_suite?: "default" | "extended";
+ /**
+ * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input.
+ * @enum {string}
+ */
+ threat_model?: "remote" | "remote_and_local";
/**
* Format: date-time
* @description Timestamp of latest configuration update.
* @example 2023-12-06T14:20:20.000Z
*/
- readonly updated_at?: string | null;
+ updated_at?: string | null;
/**
* @description The frequency of the periodic analysis.
* @enum {string|null}
*/
- readonly schedule?: "weekly" | null;
+ schedule?: "weekly" | null;
};
/** @description Configuration for code scanning default setup. */
- readonly "code-scanning-default-setup-update": {
+ "code-scanning-default-setup-update": {
/**
* @description The desired state of code scanning default setup.
* @enum {string}
*/
- readonly state?: "configured" | "not-configured";
+ state?: "configured" | "not-configured";
/**
* @description Runner type to be used.
* @enum {string}
*/
- readonly runner_type?: "standard" | "labeled";
+ runner_type?: "standard" | "labeled";
/**
* @description Runner label to be used if the runner type is labeled.
* @example code-scanning
*/
- readonly runner_label?: string | null;
+ runner_label?: string | null;
/**
* @description CodeQL query suite to be used.
* @enum {string}
*/
- readonly query_suite?: "default" | "extended";
+ query_suite?: "default" | "extended";
+ /**
+ * @description Threat model to be used for code scanning analysis. Use `remote` to analyze only network sources and `remote_and_local` to include local sources like filesystem access, command-line arguments, database reads, environment variable and standard input.
+ * @enum {string}
+ */
+ threat_model?: "remote" | "remote_and_local";
/** @description CodeQL languages to be analyzed. */
- readonly languages?: readonly ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[];
+ languages?: ("actions" | "c-cpp" | "csharp" | "go" | "java-kotlin" | "javascript-typescript" | "python" | "ruby" | "swift")[];
};
/**
* @description You can use `run_url` to track the status of the run. This includes a property status and conclusion.
* You should not rely on this always being an actions workflow run object.
*/
- readonly "code-scanning-default-setup-update-response": {
+ "code-scanning-default-setup-update-response": {
/** @description ID of the corresponding run. */
- readonly run_id?: number;
+ run_id?: number;
/** @description URL of the corresponding run. */
- readonly run_url?: string;
+ run_url?: string;
};
/**
* @description The full Git reference, formatted as `refs/heads/`,
* `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`.
* @example refs/heads/main
*/
- readonly "code-scanning-ref-full": string;
+ "code-scanning-ref-full": string;
/** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */
- readonly "code-scanning-analysis-sarif-file": string;
- readonly "code-scanning-sarifs-receipt": {
- readonly id?: components["schemas"]["code-scanning-analysis-sarif-id"];
+ "code-scanning-analysis-sarif-file": string;
+ "code-scanning-sarifs-receipt": {
+ id?: components["schemas"]["code-scanning-analysis-sarif-id"];
/**
* Format: uri
* @description The REST API URL for checking the status of the upload.
*/
readonly url?: string;
};
- readonly "code-scanning-sarifs-status": {
+ "code-scanning-sarifs-status": {
/**
* @description `pending` files have not yet been processed, while `complete` means results from the SARIF have been stored. `failed` files have either not been processed at all, or could only be partially processed.
* @enum {string}
*/
- readonly processing_status?: "pending" | "complete" | "failed";
+ processing_status?: "pending" | "complete" | "failed";
/**
* Format: uri
* @description The REST API URL for getting the analyses associated with the upload.
*/
readonly analyses_url?: string | null;
/** @description Any errors that ocurred during processing of the delivery. */
- readonly errors?: readonly string[] | null;
+ readonly errors?: string[] | null;
};
/** @description Code security configuration associated with a repository and attachment status */
- readonly "code-security-configuration-for-repository": {
+ "code-security-configuration-for-repository": {
/**
* @description The attachment status of the code security configuration on the repository.
* @enum {string}
*/
- readonly status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise";
- readonly configuration?: components["schemas"]["code-security-configuration"];
+ status?: "attached" | "attaching" | "detached" | "removed" | "enforced" | "failed" | "updating" | "removed_by_enterprise";
+ configuration?: components["schemas"]["code-security-configuration"];
};
/**
* CODEOWNERS errors
* @description A list of errors found in a repo's CODEOWNERS file
*/
- readonly "codeowners-errors": {
- readonly errors: readonly {
+ "codeowners-errors": {
+ errors: {
/**
* @description The line number where this errors occurs.
* @example 7
*/
- readonly line: number;
+ line: number;
/**
* @description The column number where this errors occurs.
* @example 3
*/
- readonly column: number;
+ column: number;
/**
* @description The contents of the line where the error occurs.
* @example * user
*/
- readonly source?: string;
+ source?: string;
/**
* @description The type of error.
* @example Invalid owner
*/
- readonly kind: string;
+ kind: string;
/**
* @description Suggested action to fix the error. This will usually be `null`, but is provided for some common errors.
* @example The pattern `/` will never match anything, did you mean `*` instead?
*/
- readonly suggestion?: string | null;
+ suggestion?: string | null;
/**
* @description A human-readable description of the error, combining information from multiple fields, laid out for display in a monospaced typeface (for example, a command-line setting).
* @example Invalid owner on line 7:
@@ -29548,891 +32663,750 @@ export type components = {
* * user
* ^
*/
- readonly message: string;
+ message: string;
/**
* @description The path of the file where the error occured.
* @example .github/CODEOWNERS
*/
- readonly path: string;
+ path: string;
}[];
};
/**
* Codespace machine
* @description A description of the machine powering a codespace.
*/
- readonly "codespace-machine": {
+ "codespace-machine": {
/**
* @description The name of the machine.
* @example standardLinux
*/
- readonly name: string;
+ name: string;
/**
* @description The display name of the machine includes cores, memory, and storage.
* @example 4 cores, 16 GB RAM, 64 GB storage
*/
- readonly display_name: string;
+ display_name: string;
/**
* @description The operating system of the machine.
* @example linux
*/
- readonly operating_system: string;
+ operating_system: string;
/**
* @description How much storage is available to the codespace.
* @example 68719476736
*/
- readonly storage_in_bytes: number;
+ storage_in_bytes: number;
/**
* @description How much memory is available to the codespace.
* @example 17179869184
*/
- readonly memory_in_bytes: number;
+ memory_in_bytes: number;
/**
* @description How many cores are available to the codespace.
* @example 4
*/
- readonly cpus: number;
+ cpus: number;
/**
* @description Whether a prebuild is currently available when creating a codespace for this machine and repository. If a branch was not specified as a ref, the default branch will be assumed. Value will be "null" if prebuilds are not supported or prebuild availability could not be determined. Value will be "none" if no prebuild is available. Latest values "ready" and "in_progress" indicate the prebuild availability status.
* @example ready
* @enum {string|null}
*/
- readonly prebuild_availability: "none" | "ready" | "in_progress" | null;
+ prebuild_availability: "none" | "ready" | "in_progress" | null;
};
/**
* Codespaces Permissions Check
* @description Permission check result for a given devcontainer config.
*/
- readonly "codespaces-permissions-check-for-devcontainer": {
+ "codespaces-permissions-check-for-devcontainer": {
/**
* @description Whether the user has accepted the permissions defined by the devcontainer config
* @example true
*/
- readonly accepted: boolean;
+ accepted: boolean;
};
/**
* Codespaces Secret
* @description Set repository secrets for GitHub Codespaces.
*/
- readonly "repo-codespaces-secret": {
+ "repo-codespaces-secret": {
/**
* @description The name of the secret.
* @example SECRET_TOKEN
*/
- readonly name: string;
+ name: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/**
* Collaborator
* @description Collaborator
*/
- readonly collaborator: {
+ collaborator: {
/** @example octocat */
- readonly login: string;
+ login: string;
/**
* Format: int64
* @example 1
*/
- readonly id: number;
- readonly email?: string | null;
- readonly name?: string | null;
+ id: number;
+ email?: string | null;
+ name?: string | null;
/** @example MDQ6VXNlcjE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://github.com/images/error/octocat_happy.gif
*/
- readonly avatar_url: string;
+ avatar_url: string;
/** @example 41d064eb2195891e12d0413f63227ea7 */
- readonly gravatar_id: string | null;
+ gravatar_id: string | null;
/**
* Format: uri
* @example https://api.github.com/users/octocat
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/followers
*/
- readonly followers_url: string;
+ followers_url: string;
/** @example https://api.github.com/users/octocat/following{/other_user} */
- readonly following_url: string;
+ following_url: string;
/** @example https://api.github.com/users/octocat/gists{/gist_id} */
- readonly gists_url: string;
+ gists_url: string;
/** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
- readonly starred_url: string;
+ starred_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/subscriptions
*/
- readonly subscriptions_url: string;
+ subscriptions_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/orgs
*/
- readonly organizations_url: string;
+ organizations_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/repos
*/
- readonly repos_url: string;
+ repos_url: string;
/** @example https://api.github.com/users/octocat/events{/privacy} */
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/received_events
*/
- readonly received_events_url: string;
+ received_events_url: string;
/** @example User */
- readonly type: string;
- readonly site_admin: boolean;
- readonly permissions?: {
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- readonly admin: boolean;
+ type: string;
+ site_admin: boolean;
+ permissions?: {
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ admin: boolean;
};
/** @example admin */
- readonly role_name: string;
+ role_name: string;
/** @example public */
- readonly user_view_type?: string;
+ user_view_type?: string;
};
/**
* Repository Invitation
* @description Repository invitations let you manage who you collaborate with.
*/
- readonly "repository-invitation": {
+ "repository-invitation": {
/**
* Format: int64
* @description Unique identifier of the repository invitation.
* @example 42
*/
- readonly id: number;
- readonly repository: components["schemas"]["minimal-repository"];
- readonly invitee: components["schemas"]["nullable-simple-user"];
- readonly inviter: components["schemas"]["nullable-simple-user"];
+ id: number;
+ repository: components["schemas"]["minimal-repository"];
+ invitee: components["schemas"]["nullable-simple-user"];
+ inviter: components["schemas"]["nullable-simple-user"];
/**
* @description The permission associated with the invitation.
* @example read
* @enum {string}
*/
- readonly permissions: "read" | "write" | "admin" | "triage" | "maintain";
+ permissions: "read" | "write" | "admin" | "triage" | "maintain";
/**
* Format: date-time
* @example 2016-06-13T14:52:50-05:00
*/
- readonly created_at: string;
+ created_at: string;
/** @description Whether or not the invitation has expired */
- readonly expired?: boolean;
+ expired?: boolean;
/**
* @description URL for the repository invitation
* @example https://api.github.com/user/repository-invitations/1
*/
- readonly url: string;
+ url: string;
/** @example https://github.com/octocat/Hello-World/invitations */
- readonly html_url: string;
- readonly node_id: string;
+ html_url: string;
+ node_id: string;
};
/**
* Collaborator
* @description Collaborator
*/
- readonly "nullable-collaborator": {
+ "nullable-collaborator": {
/** @example octocat */
- readonly login: string;
+ login: string;
/**
* Format: int64
* @example 1
*/
- readonly id: number;
- readonly email?: string | null;
- readonly name?: string | null;
+ id: number;
+ email?: string | null;
+ name?: string | null;
/** @example MDQ6VXNlcjE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://github.com/images/error/octocat_happy.gif
*/
- readonly avatar_url: string;
+ avatar_url: string;
/** @example 41d064eb2195891e12d0413f63227ea7 */
- readonly gravatar_id: string | null;
+ gravatar_id: string | null;
/**
* Format: uri
* @example https://api.github.com/users/octocat
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/followers
*/
- readonly followers_url: string;
+ followers_url: string;
/** @example https://api.github.com/users/octocat/following{/other_user} */
- readonly following_url: string;
+ following_url: string;
/** @example https://api.github.com/users/octocat/gists{/gist_id} */
- readonly gists_url: string;
+ gists_url: string;
/** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
- readonly starred_url: string;
+ starred_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/subscriptions
*/
- readonly subscriptions_url: string;
+ subscriptions_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/orgs
*/
- readonly organizations_url: string;
+ organizations_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/repos
*/
- readonly repos_url: string;
+ repos_url: string;
/** @example https://api.github.com/users/octocat/events{/privacy} */
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/received_events
*/
- readonly received_events_url: string;
+ received_events_url: string;
/** @example User */
- readonly type: string;
- readonly site_admin: boolean;
- readonly permissions?: {
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- readonly admin: boolean;
+ type: string;
+ site_admin: boolean;
+ permissions?: {
+ pull: boolean;
+ triage?: boolean;
+ push: boolean;
+ maintain?: boolean;
+ admin: boolean;
};
/** @example admin */
- readonly role_name: string;
+ role_name: string;
/** @example public */
- readonly user_view_type?: string;
+ user_view_type?: string;
} | null;
/**
* Repository Collaborator Permission
* @description Repository Collaborator Permission
*/
- readonly "repository-collaborator-permission": {
- readonly permission: string;
+ "repository-collaborator-permission": {
+ permission: string;
/** @example admin */
- readonly role_name: string;
- readonly user: components["schemas"]["nullable-collaborator"];
+ role_name: string;
+ user: components["schemas"]["nullable-collaborator"];
};
/**
* Commit Comment
* @description Commit Comment
*/
- readonly "commit-comment": {
+ "commit-comment": {
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: uri */
- readonly url: string;
- readonly id: number;
- readonly node_id: string;
- readonly body: string;
- readonly path: string | null;
- readonly position: number | null;
- readonly line: number | null;
- readonly commit_id: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ url: string;
+ id: number;
+ node_id: string;
+ body: string;
+ path: string | null;
+ position: number | null;
+ line: number | null;
+ commit_id: string;
+ user: components["schemas"]["nullable-simple-user"];
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
- readonly author_association: components["schemas"]["author-association"];
- readonly reactions?: components["schemas"]["reaction-rollup"];
- };
- /**
- * Branch Short
- * @description Branch Short
- */
- readonly "branch-short": {
- readonly name: string;
- readonly commit: {
- readonly sha: string;
- readonly url: string;
- };
- readonly protected: boolean;
+ updated_at: string;
+ author_association: components["schemas"]["author-association"];
+ reactions?: components["schemas"]["reaction-rollup"];
};
/**
- * Link
- * @description Hypermedia Link
- */
- readonly link: {
- readonly href: string;
- };
- /**
- * Auto merge
- * @description The status of auto merging a pull request.
+ * Reaction
+ * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively.
*/
- readonly "auto-merge": {
- readonly enabled_by: components["schemas"]["simple-user"];
+ reaction: {
+ /** @example 1 */
+ id: number;
+ /** @example MDg6UmVhY3Rpb24x */
+ node_id: string;
+ user: components["schemas"]["nullable-simple-user"];
/**
- * @description The merge method to use.
+ * @description The reaction to use
+ * @example heart
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
- /** @description Title for the merge commit message. */
- readonly commit_title: string;
- /** @description Commit message for the merge commit. */
- readonly commit_message: string;
- } | null;
- /**
- * Pull Request Simple
- * @description Pull Request Simple
- */
- readonly "pull-request-simple": {
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
- */
- readonly url: string;
- /**
- * Format: int64
- * @example 1
- */
- readonly id: number;
- /** @example MDExOlB1bGxSZXF1ZXN0MQ== */
- readonly node_id: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347
- */
- readonly html_url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.diff
- */
- readonly diff_url: string;
- /**
- * Format: uri
- * @example https://github.com/octocat/Hello-World/pull/1347.patch
- */
- readonly patch_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
- */
- readonly issue_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
- */
- readonly commits_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
- */
- readonly review_comments_url: string;
- /** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
- readonly review_comment_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
- */
- readonly comments_url: string;
- /**
- * Format: uri
- * @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
- */
- readonly statuses_url: string;
- /** @example 1347 */
- readonly number: number;
- /** @example open */
- readonly state: string;
- /** @example true */
- readonly locked: boolean;
- /** @example new-feature */
- readonly title: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- /** @example Please pull these awesome changes */
- readonly body: string | null;
- readonly labels: readonly {
- /** Format: int64 */
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly name: string;
- readonly description: string;
- readonly color: string;
- readonly default: boolean;
- }[];
- readonly milestone: components["schemas"]["nullable-milestone"];
- /** @example too heated */
- readonly active_lock_reason?: string | null;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly updated_at: string;
- /**
- * Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly closed_at: string | null;
+ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
/**
* Format: date-time
- * @example 2011-01-26T19:01:12Z
- */
- readonly merged_at: string | null;
- /** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */
- readonly merge_commit_sha: string | null;
- readonly assignee: components["schemas"]["nullable-simple-user"];
- readonly assignees?: readonly components["schemas"]["simple-user"][] | null;
- readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null;
- readonly requested_teams?: readonly components["schemas"]["team"][] | null;
- readonly head: {
- readonly label: string;
- readonly ref: string;
- readonly repo: components["schemas"]["repository"];
- readonly sha: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- };
- readonly base: {
- readonly label: string;
- readonly ref: string;
- readonly repo: components["schemas"]["repository"];
- readonly sha: string;
- readonly user: components["schemas"]["nullable-simple-user"];
- };
- readonly _links: {
- readonly comments: components["schemas"]["link"];
- readonly commits: components["schemas"]["link"];
- readonly statuses: components["schemas"]["link"];
- readonly html: components["schemas"]["link"];
- readonly issue: components["schemas"]["link"];
- readonly review_comments: components["schemas"]["link"];
- readonly review_comment: components["schemas"]["link"];
- readonly self: components["schemas"]["link"];
- };
- readonly author_association: components["schemas"]["author-association"];
- readonly auto_merge: components["schemas"]["auto-merge"];
- /**
- * @description Indicates whether or not the pull request is a draft.
- * @example false
+ * @example 2016-05-20T20:09:31Z
*/
- readonly draft?: boolean;
+ created_at: string;
+ };
+ /**
+ * Branch Short
+ * @description Branch Short
+ */
+ "branch-short": {
+ name: string;
+ commit: {
+ sha: string;
+ url: string;
+ };
+ protected: boolean;
};
/** Simple Commit Status */
- readonly "simple-commit-status": {
- readonly description: string | null;
- readonly id: number;
- readonly node_id: string;
- readonly state: string;
- readonly context: string;
+ "simple-commit-status": {
+ description: string | null;
+ id: number;
+ node_id: string;
+ state: string;
+ context: string;
/** Format: uri */
- readonly target_url: string | null;
- readonly required?: boolean | null;
+ target_url: string | null;
+ required?: boolean | null;
/** Format: uri */
- readonly avatar_url: string | null;
+ avatar_url: string | null;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/**
* Combined Commit Status
* @description Combined Commit Status
*/
- readonly "combined-commit-status": {
- readonly state: string;
- readonly statuses: readonly components["schemas"]["simple-commit-status"][];
- readonly sha: string;
- readonly total_count: number;
- readonly repository: components["schemas"]["minimal-repository"];
+ "combined-commit-status": {
+ state: string;
+ statuses: components["schemas"]["simple-commit-status"][];
+ sha: string;
+ total_count: number;
+ repository: components["schemas"]["minimal-repository"];
/** Format: uri */
- readonly commit_url: string;
+ commit_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/**
* Status
* @description The status of a commit.
*/
- readonly status: {
- readonly url: string;
- readonly avatar_url: string | null;
- readonly id: number;
- readonly node_id: string;
- readonly state: string;
- readonly description: string | null;
- readonly target_url: string | null;
- readonly context: string;
- readonly created_at: string;
- readonly updated_at: string;
- readonly creator: components["schemas"]["nullable-simple-user"];
+ status: {
+ url: string;
+ avatar_url: string | null;
+ id: number;
+ node_id: string;
+ state: string;
+ description: string | null;
+ target_url: string | null;
+ context: string;
+ created_at: string;
+ updated_at: string;
+ creator: components["schemas"]["nullable-simple-user"];
};
/**
* Code Of Conduct Simple
* @description Code of Conduct Simple
*/
- readonly "nullable-code-of-conduct-simple": {
+ "nullable-code-of-conduct-simple": {
/**
* Format: uri
* @example https://api.github.com/repos/github/docs/community/code_of_conduct
*/
- readonly url: string;
+ url: string;
/** @example citizen_code_of_conduct */
- readonly key: string;
+ key: string;
/** @example Citizen Code of Conduct */
- readonly name: string;
+ name: string;
/**
* Format: uri
* @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
*/
- readonly html_url: string | null;
+ html_url: string | null;
} | null;
/** Community Health File */
- readonly "nullable-community-health-file": {
+ "nullable-community-health-file": {
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
} | null;
/**
* Community Profile
* @description Community Profile
*/
- readonly "community-profile": {
+ "community-profile": {
/** @example 100 */
- readonly health_percentage: number;
+ health_percentage: number;
/** @example My first repository on GitHub! */
- readonly description: string | null;
+ description: string | null;
/** @example example.com */
- readonly documentation: string | null;
- readonly files: {
- readonly code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"];
- readonly code_of_conduct_file: components["schemas"]["nullable-community-health-file"];
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly contributing: components["schemas"]["nullable-community-health-file"];
- readonly readme: components["schemas"]["nullable-community-health-file"];
- readonly issue_template: components["schemas"]["nullable-community-health-file"];
- readonly pull_request_template: components["schemas"]["nullable-community-health-file"];
+ documentation: string | null;
+ files: {
+ code_of_conduct: components["schemas"]["nullable-code-of-conduct-simple"];
+ code_of_conduct_file: components["schemas"]["nullable-community-health-file"];
+ license: components["schemas"]["nullable-license-simple"];
+ contributing: components["schemas"]["nullable-community-health-file"];
+ readme: components["schemas"]["nullable-community-health-file"];
+ issue_template: components["schemas"]["nullable-community-health-file"];
+ pull_request_template: components["schemas"]["nullable-community-health-file"];
};
/**
* Format: date-time
* @example 2017-02-28T19:09:29Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
/** @example true */
- readonly content_reports_enabled?: boolean;
+ content_reports_enabled?: boolean;
};
/**
* Commit Comparison
* @description Commit Comparison
*/
- readonly "commit-comparison": {
+ "commit-comparison": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/compare/master...topic
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/compare/master...topic
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17
*/
- readonly permalink_url: string;
+ permalink_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/compare/master...topic.diff
*/
- readonly diff_url: string;
+ diff_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/compare/master...topic.patch
*/
- readonly patch_url: string;
- readonly base_commit: components["schemas"]["commit"];
- readonly merge_base_commit: components["schemas"]["commit"];
+ patch_url: string;
+ base_commit: components["schemas"]["commit"];
+ merge_base_commit: components["schemas"]["commit"];
/**
* @example ahead
* @enum {string}
*/
- readonly status: "diverged" | "ahead" | "behind" | "identical";
+ status: "diverged" | "ahead" | "behind" | "identical";
/** @example 4 */
- readonly ahead_by: number;
+ ahead_by: number;
/** @example 5 */
- readonly behind_by: number;
+ behind_by: number;
/** @example 6 */
- readonly total_commits: number;
- readonly commits: readonly components["schemas"]["commit"][];
- readonly files?: readonly components["schemas"]["diff-entry"][];
+ total_commits: number;
+ commits: components["schemas"]["commit"][];
+ files?: components["schemas"]["diff-entry"][];
};
/**
* Content Tree
* @description Content Tree
*/
- readonly "content-tree": {
- readonly type: string;
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly sha: string;
- readonly content?: string;
+ "content-tree": {
+ type: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
+ content?: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly entries?: readonly {
- readonly type: string;
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly sha: string;
+ download_url: string | null;
+ entries?: {
+ type: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly _links: {
+ download_url: string | null;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
}[];
- readonly _links: {
+ encoding?: string;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
};
/**
* Content Directory
* @description A list of directory items
*/
- readonly "content-directory": readonly {
+ "content-directory": {
/** @enum {string} */
- readonly type: "dir" | "file" | "submodule" | "symlink";
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly content?: string;
- readonly sha: string;
+ type: "dir" | "file" | "submodule" | "symlink";
+ size: number;
+ name: string;
+ path: string;
+ content?: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly _links: {
+ download_url: string | null;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
}[];
/**
* Content File
* @description Content File
*/
- readonly "content-file": {
+ "content-file": {
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
- readonly type: "file";
- readonly encoding: string;
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly content: string;
- readonly sha: string;
+ type: "file";
+ encoding: string;
+ size: number;
+ name: string;
+ path: string;
+ content: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly _links: {
+ download_url: string | null;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
/** @example "actual/actual.md" */
- readonly target?: string;
+ target?: string;
/** @example "git://example.com/defunkt/dotjs.git" */
- readonly submodule_git_url?: string;
+ submodule_git_url?: string;
};
/**
* Symlink Content
* @description An object describing a symlink
*/
- readonly "content-symlink": {
+ "content-symlink": {
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
- readonly type: "symlink";
- readonly target: string;
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly sha: string;
+ type: "symlink";
+ target: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly _links: {
+ download_url: string | null;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
};
/**
* Submodule Content
* @description An object describing a submodule
*/
- readonly "content-submodule": {
+ "content-submodule": {
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
- readonly type: "submodule";
+ type: "submodule";
/** Format: uri */
- readonly submodule_git_url: string;
- readonly size: number;
- readonly name: string;
- readonly path: string;
- readonly sha: string;
+ submodule_git_url: string;
+ size: number;
+ name: string;
+ path: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly _links: {
+ download_url: string | null;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
};
/**
* File Commit
* @description File Commit
*/
- readonly "file-commit": {
- readonly content: {
- readonly name?: string;
- readonly path?: string;
- readonly sha?: string;
- readonly size?: number;
- readonly url?: string;
- readonly html_url?: string;
- readonly git_url?: string;
- readonly download_url?: string;
- readonly type?: string;
- readonly _links?: {
- readonly self?: string;
- readonly git?: string;
- readonly html?: string;
+ "file-commit": {
+ content: {
+ name?: string;
+ path?: string;
+ sha?: string;
+ size?: number;
+ url?: string;
+ html_url?: string;
+ git_url?: string;
+ download_url?: string;
+ type?: string;
+ _links?: {
+ self?: string;
+ git?: string;
+ html?: string;
};
} | null;
- readonly commit: {
- readonly sha?: string;
- readonly node_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly author?: {
- readonly date?: string;
- readonly name?: string;
- readonly email?: string;
- };
- readonly committer?: {
- readonly date?: string;
- readonly name?: string;
- readonly email?: string;
- };
- readonly message?: string;
- readonly tree?: {
- readonly url?: string;
- readonly sha?: string;
- };
- readonly parents?: readonly {
- readonly url?: string;
- readonly html_url?: string;
- readonly sha?: string;
+ commit: {
+ sha?: string;
+ node_id?: string;
+ url?: string;
+ html_url?: string;
+ author?: {
+ date?: string;
+ name?: string;
+ email?: string;
+ };
+ committer?: {
+ date?: string;
+ name?: string;
+ email?: string;
+ };
+ message?: string;
+ tree?: {
+ url?: string;
+ sha?: string;
+ };
+ parents?: {
+ url?: string;
+ html_url?: string;
+ sha?: string;
}[];
- readonly verification?: {
- readonly verified?: boolean;
- readonly reason?: string;
- readonly signature?: string | null;
- readonly payload?: string | null;
- readonly verified_at?: string | null;
+ verification?: {
+ verified?: boolean;
+ reason?: string;
+ signature?: string | null;
+ payload?: string | null;
+ verified_at?: string | null;
};
};
};
/** @description The ID of the push protection bypass placeholder. This value is returned on any push protected routes. */
- readonly "secret-scanning-push-protection-bypass-placeholder-id": string;
+ "secret-scanning-push-protection-bypass-placeholder-id": string;
/** @description Repository rule violation was detected */
- readonly "repository-rule-violation-error": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly status?: string;
- readonly metadata?: {
- readonly secret_scanning?: {
- readonly bypass_placeholders?: readonly {
- readonly placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"];
- readonly token_type?: string;
+ "repository-rule-violation-error": {
+ message?: string;
+ documentation_url?: string;
+ status?: string;
+ metadata?: {
+ secret_scanning?: {
+ bypass_placeholders?: {
+ placeholder_id?: components["schemas"]["secret-scanning-push-protection-bypass-placeholder-id"];
+ token_type?: string;
}[];
};
};
@@ -30441,41 +33415,41 @@ export type components = {
* Contributor
* @description Contributor
*/
- readonly contributor: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
+ contributor: {
+ login?: string;
+ id?: number;
+ node_id?: string;
/** Format: uri */
- readonly avatar_url?: string;
- readonly gravatar_id?: string | null;
+ avatar_url?: string;
+ gravatar_id?: string | null;
/** Format: uri */
- readonly url?: string;
+ url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: uri */
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly events_url?: string;
+ repos_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
- readonly type: string;
- readonly site_admin?: boolean;
- readonly contributions: number;
- readonly email?: string;
- readonly name?: string;
- readonly user_view_type?: string;
+ received_events_url?: string;
+ type: string;
+ site_admin?: boolean;
+ contributions: number;
+ email?: string;
+ name?: string;
+ user_view_type?: string;
};
/** @description A Dependabot alert. */
- readonly "dependabot-alert": {
- readonly number: components["schemas"]["alert-number"];
+ "dependabot-alert": {
+ number: components["schemas"]["alert-number"];
/**
* @description The state of the Dependabot alert.
* @enum {string}
@@ -30483,7 +33457,7 @@ export type components = {
readonly state: "auto_dismissed" | "dismissed" | "fixed" | "open";
/** @description Details for the vulnerable dependency. */
readonly dependency: {
- readonly package?: components["schemas"]["dependabot-alert-package"];
+ package?: components["schemas"]["dependabot-alert-package"];
/** @description The full path to the dependency manifest file, relative to the root of the repository. */
readonly manifest_path?: string;
/**
@@ -30491,200 +33465,211 @@ export type components = {
* @enum {string|null}
*/
readonly scope?: "development" | "runtime" | null;
+ /**
+ * @description The vulnerable dependency's relationship to your project.
+ *
+ * > [!NOTE]
+ * > We are rolling out support for dependency relationship across ecosystems. This value will be "unknown" for all dependencies in unsupported ecosystems.
+ * @enum {string|null}
+ */
+ readonly relationship?: "unknown" | "direct" | "transitive" | null;
};
- readonly security_advisory: components["schemas"]["dependabot-alert-security-advisory"];
- readonly security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"];
- readonly url: components["schemas"]["alert-url"];
- readonly html_url: components["schemas"]["alert-html-url"];
- readonly created_at: components["schemas"]["alert-created-at"];
- readonly updated_at: components["schemas"]["alert-updated-at"];
- readonly dismissed_at: components["schemas"]["alert-dismissed-at"];
- readonly dismissed_by: components["schemas"]["nullable-simple-user"];
+ security_advisory: components["schemas"]["dependabot-alert-security-advisory"];
+ security_vulnerability: components["schemas"]["dependabot-alert-security-vulnerability"];
+ url: components["schemas"]["alert-url"];
+ html_url: components["schemas"]["alert-html-url"];
+ created_at: components["schemas"]["alert-created-at"];
+ updated_at: components["schemas"]["alert-updated-at"];
+ dismissed_at: components["schemas"]["alert-dismissed-at"];
+ dismissed_by: components["schemas"]["nullable-simple-user"];
/**
* @description The reason that the alert was dismissed.
* @enum {string|null}
*/
- readonly dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null;
+ dismissed_reason: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk" | null;
/** @description An optional comment associated with the alert's dismissal. */
- readonly dismissed_comment: string | null;
- readonly fixed_at: components["schemas"]["alert-fixed-at"];
- readonly auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"];
+ dismissed_comment: string | null;
+ fixed_at: components["schemas"]["alert-fixed-at"];
+ auto_dismissed_at?: components["schemas"]["alert-auto-dismissed-at"];
+ dismissal_request?: components["schemas"]["dependabot-alert-dismissal-request-simple"];
+ /** @description The users assigned to this alert. */
+ readonly assignees?: components["schemas"]["simple-user"][];
};
/**
* Dependabot Secret
* @description Set secrets for Dependabot.
*/
- readonly "dependabot-secret": {
+ "dependabot-secret": {
/**
* @description The name of the secret.
* @example MY_ARTIFACTORY_PASSWORD
*/
- readonly name: string;
+ name: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/**
* Dependency Graph Diff
* @description A diff of the dependencies between two commits.
*/
- readonly "dependency-graph-diff": readonly {
+ "dependency-graph-diff": {
/** @enum {string} */
- readonly change_type: "added" | "removed";
+ change_type: "added" | "removed";
/** @example path/to/package-lock.json */
- readonly manifest: string;
+ manifest: string;
/** @example npm */
- readonly ecosystem: string;
+ ecosystem: string;
/** @example @actions/core */
- readonly name: string;
+ name: string;
/** @example 1.0.0 */
- readonly version: string;
+ version: string;
/** @example pkg:/npm/%40actions/core@1.1.0 */
- readonly package_url: string | null;
+ package_url: string | null;
/** @example MIT */
- readonly license: string | null;
+ license: string | null;
/** @example https://github.com/github/actions */
- readonly source_repository_url: string | null;
- readonly vulnerabilities: readonly {
+ source_repository_url: string | null;
+ vulnerabilities: {
/** @example critical */
- readonly severity: string;
+ severity: string;
/** @example GHSA-rf4j-j272-fj86 */
- readonly advisory_ghsa_id: string;
+ advisory_ghsa_id: string;
/** @example A summary of the advisory. */
- readonly advisory_summary: string;
+ advisory_summary: string;
/** @example https://github.com/advisories/GHSA-rf4j-j272-fj86 */
- readonly advisory_url: string;
+ advisory_url: string;
}[];
/**
* @description Where the dependency is utilized. `development` means that the dependency is only utilized in the development environment. `runtime` means that the dependency is utilized at runtime and in the development environment.
* @enum {string}
*/
- readonly scope: "unknown" | "runtime" | "development";
+ scope: "unknown" | "runtime" | "development";
}[];
/**
* Dependency Graph SPDX SBOM
* @description A schema for the SPDX JSON format returned by the Dependency Graph.
*/
- readonly "dependency-graph-spdx-sbom": {
- readonly sbom: {
+ "dependency-graph-spdx-sbom": {
+ sbom: {
/**
* @description The SPDX identifier for the SPDX document.
* @example SPDXRef-DOCUMENT
*/
- readonly SPDXID: string;
+ SPDXID: string;
/**
* @description The version of the SPDX specification that this document conforms to.
* @example SPDX-2.3
*/
- readonly spdxVersion: string;
+ spdxVersion: string;
/**
* @description An optional comment about the SPDX document.
* @example Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/
*/
- readonly comment?: string;
- readonly creationInfo: {
+ comment?: string;
+ creationInfo: {
/**
* @description The date and time the SPDX document was created.
* @example 2021-11-03T00:00:00Z
*/
- readonly created: string;
+ created: string;
/** @description The tools that were used to generate the SPDX document. */
- readonly creators: readonly string[];
+ creators: string[];
};
/**
* @description The name of the SPDX document.
* @example github/github
*/
- readonly name: string;
+ name: string;
/**
* @description The license under which the SPDX document is licensed.
* @example CC0-1.0
*/
- readonly dataLicense: string;
+ dataLicense: string;
/**
* @description The namespace for the SPDX document.
* @example https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57
*/
- readonly documentNamespace: string;
- readonly packages: readonly {
+ documentNamespace: string;
+ packages: {
/**
* @description A unique SPDX identifier for the package.
* @example SPDXRef-Package
*/
- readonly SPDXID?: string;
+ SPDXID?: string;
/**
* @description The name of the package.
* @example github/github
*/
- readonly name?: string;
+ name?: string;
/**
* @description The version of the package. If the package does not have an exact version specified,
* a version range is given.
* @example 1.0.0
*/
- readonly versionInfo?: string;
+ versionInfo?: string;
/**
* @description The location where the package can be downloaded,
* or NOASSERTION if this has not been determined.
* @example NOASSERTION
*/
- readonly downloadLocation?: string;
+ downloadLocation?: string;
/**
* @description Whether the package's file content has been subjected to
* analysis during the creation of the SPDX document.
* @example false
*/
- readonly filesAnalyzed?: boolean;
+ filesAnalyzed?: boolean;
/**
* @description The license of the package as determined while creating the SPDX document.
* @example MIT
*/
- readonly licenseConcluded?: string;
+ licenseConcluded?: string;
/**
* @description The license of the package as declared by its author, or NOASSERTION if this information
* was not available when the SPDX document was created.
* @example NOASSERTION
*/
- readonly licenseDeclared?: string;
+ licenseDeclared?: string;
/**
* @description The distribution source of this package, or NOASSERTION if this was not determined.
* @example NOASSERTION
*/
- readonly supplier?: string;
+ supplier?: string;
/**
* @description The copyright holders of the package, and any dates present with those notices, if available.
* @example Copyright (c) 1985 GitHub.com
*/
- readonly copyrightText?: string;
- readonly externalRefs?: readonly {
+ copyrightText?: string;
+ externalRefs?: {
/**
* @description The category of reference to an external resource this reference refers to.
* @example PACKAGE-MANAGER
*/
- readonly referenceCategory: string;
+ referenceCategory: string;
/**
* @description A locator for the particular external resource this reference refers to.
* @example pkg:gem/rails@6.0.1
*/
- readonly referenceLocator: string;
+ referenceLocator: string;
/**
* @description The category of reference to an external resource this reference refers to.
* @example purl
*/
- readonly referenceType: string;
+ referenceType: string;
}[];
}[];
- readonly relationships?: readonly {
+ relationships?: {
/**
* @description The type of relationship between the two SPDX elements.
* @example DEPENDS_ON
*/
- readonly relationshipType?: string;
+ relationshipType?: string;
/** @description The SPDX identifier of the package that is the source of the relationship. */
- readonly spdxElementId?: string;
+ spdxElementId?: string;
/** @description The SPDX identifier of the package that is the target of the relationship. */
- readonly relatedSpdxElement?: string;
+ relatedSpdxElement?: string;
}[];
};
};
@@ -30692,309 +33677,309 @@ export type components = {
* metadata
* @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
*/
- readonly metadata: {
- readonly [key: string]: (string | number | boolean) | null;
+ metadata: {
+ [key: string]: (string | number | boolean) | null;
};
- readonly dependency: {
+ dependency: {
/**
* @description Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
* @example pkg:/npm/%40actions/http-client@1.0.11
*/
- readonly package_url?: string;
- readonly metadata?: components["schemas"]["metadata"];
+ package_url?: string;
+ metadata?: components["schemas"]["metadata"];
/**
* @description A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
* @example direct
* @enum {string}
*/
- readonly relationship?: "direct" | "indirect";
+ relationship?: "direct" | "indirect";
/**
* @description A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
* @example runtime
* @enum {string}
*/
- readonly scope?: "runtime" | "development";
+ scope?: "runtime" | "development";
/**
* @description Array of package-url (PURLs) of direct child dependencies.
* @example @actions/http-client
*/
- readonly dependencies?: readonly string[];
+ dependencies?: string[];
};
- readonly manifest: {
+ manifest: {
/**
* @description The name of the manifest.
* @example package-lock.json
*/
- readonly name: string;
- readonly file?: {
+ name: string;
+ file?: {
/**
* @description The path of the manifest file relative to the root of the Git repository.
* @example /src/build/package-lock.json
*/
- readonly source_location?: string;
+ source_location?: string;
};
- readonly metadata?: components["schemas"]["metadata"];
+ metadata?: components["schemas"]["metadata"];
/** @description A collection of resolved package dependencies. */
- readonly resolved?: {
- readonly [key: string]: components["schemas"]["dependency"];
+ resolved?: {
+ [key: string]: components["schemas"]["dependency"];
};
};
/**
* snapshot
* @description Create a new snapshot of a repository's dependencies.
*/
- readonly snapshot: {
+ snapshot: {
/** @description The version of the repository snapshot submission. */
- readonly version: number;
- readonly job: {
+ version: number;
+ job: {
/**
* @description The external ID of the job.
* @example 5622a2b0-63f6-4732-8c34-a1ab27e102a11
*/
- readonly id: string;
+ id: string;
/**
* @description Correlator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of `job.correlator` and `detector.name` will be considered when calculating a repository's current dependencies. Correlator should be as unique as it takes to distinguish all detection runs for a given "wave" of CI workflow you run. If you're using GitHub Actions, a good default value for this could be the environment variables GITHUB_WORKFLOW and GITHUB_JOB concatenated together. If you're using a build matrix, then you'll also need to add additional key(s) to distinguish between each submission inside a matrix variation.
* @example yourworkflowname_yourjobname
*/
- readonly correlator: string;
+ correlator: string;
/**
* @description The url for the job.
* @example http://example.com/build
*/
- readonly html_url?: string;
+ html_url?: string;
};
/**
* @description The commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
* @example ddc951f4b1293222421f2c8df679786153acf689
*/
- readonly sha: string;
+ sha: string;
/**
* @description The repository branch that triggered this snapshot.
* @example refs/heads/main
*/
- readonly ref: string;
+ ref: string;
/** @description A description of the detector used. */
- readonly detector: {
+ detector: {
/**
* @description The name of the detector used.
* @example docker buildtime detector
*/
- readonly name: string;
+ name: string;
/**
* @description The version of the detector used.
* @example 1.0.0
*/
- readonly version: string;
+ version: string;
/**
* @description The url of the detector used.
* @example http://example.com/docker-buildtimer-detector
*/
- readonly url: string;
+ url: string;
};
- readonly metadata?: components["schemas"]["metadata"];
+ metadata?: components["schemas"]["metadata"];
/** @description A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies. */
- readonly manifests?: {
- readonly [key: string]: components["schemas"]["manifest"];
+ manifests?: {
+ [key: string]: components["schemas"]["manifest"];
};
/**
* Format: date-time
* @description The time at which the snapshot was scanned.
* @example 2020-06-13T14:52:50-05:00
*/
- readonly scanned: string;
+ scanned: string;
};
/**
* Deployment Status
* @description The status of a deployment.
*/
- readonly "deployment-status": {
+ "deployment-status": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1
*/
- readonly url: string;
+ url: string;
/**
* Format: int64
* @example 1
*/
- readonly id: number;
+ id: number;
/** @example MDE2OkRlcGxveW1lbnRTdGF0dXMx */
- readonly node_id: string;
+ node_id: string;
/**
* @description The state of the status.
* @example success
* @enum {string}
*/
- readonly state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress";
- readonly creator: components["schemas"]["nullable-simple-user"];
+ state: "error" | "failure" | "inactive" | "pending" | "success" | "queued" | "in_progress";
+ creator: components["schemas"]["nullable-simple-user"];
/**
* @description A short description of the status.
* @default
* @example Deployment finished successfully.
*/
- readonly description: string;
+ description: string;
/**
* @description The environment of the deployment that the status is for.
* @default
* @example production
*/
- readonly environment: string;
+ environment: string;
/**
* Format: uri
* @description Closing down notice: the URL to associate with this status.
* @default
* @example https://example.com/deployment/42/output
*/
- readonly target_url: string;
+ target_url: string;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2012-07-20T01:19:13Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/deployments/42
*/
- readonly deployment_url: string;
+ deployment_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example
*/
- readonly repository_url: string;
+ repository_url: string;
/**
* Format: uri
* @description The URL for accessing your environment.
* @default
* @example https://staging.example.com/
*/
- readonly environment_url: string;
+ environment_url: string;
/**
* Format: uri
* @description The URL to associate with this status.
* @default
* @example https://example.com/deployment/42/output
*/
- readonly log_url: string;
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
+ log_url: string;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
* @description The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
* @example 30
*/
- readonly "wait-timer": number;
+ "wait-timer": number;
/** @description The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. */
- readonly "deployment-branch-policy-settings": {
+ "deployment-branch-policy-settings": {
/** @description Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`. */
- readonly protected_branches: boolean;
+ protected_branches: boolean;
/** @description Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`. */
- readonly custom_branch_policies: boolean;
+ custom_branch_policies: boolean;
} | null;
/**
* Environment
* @description Details of a deployment environment
*/
- readonly environment: {
+ environment: {
/**
* Format: int64
* @description The id of the environment.
* @example 56780428
*/
- readonly id: number;
+ id: number;
/** @example MDExOkVudmlyb25tZW50NTY3ODA0Mjg= */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the environment.
* @example staging
*/
- readonly name: string;
+ name: string;
/** @example https://api.github.com/repos/github/hello-world/environments/staging */
- readonly url: string;
+ url: string;
/** @example https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging */
- readonly html_url: string;
+ html_url: string;
/**
* Format: date-time
* @description The time that the environment was created, in ISO 8601 format.
* @example 2020-11-23T22:00:40Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The time that the environment was last updated, in ISO 8601 format.
* @example 2020-11-23T22:00:40Z
*/
- readonly updated_at: string;
+ updated_at: string;
/** @description Built-in deployment protection rules for the environment. */
- readonly protection_rules?: readonly ({
+ protection_rules?: ({
/** @example 3515 */
- readonly id: number;
+ id: number;
/** @example MDQ6R2F0ZTM1MTU= */
- readonly node_id: string;
+ node_id: string;
/** @example wait_timer */
- readonly type: string;
- readonly wait_timer?: components["schemas"]["wait-timer"];
+ type: string;
+ wait_timer?: components["schemas"]["wait-timer"];
} | {
/** @example 3755 */
- readonly id: number;
+ id: number;
/** @example MDQ6R2F0ZTM3NTU= */
- readonly node_id: string;
+ node_id: string;
/**
* @description Whether deployments to this environment can be approved by the user who created the deployment.
* @example false
*/
- readonly prevent_self_review?: boolean;
+ prevent_self_review?: boolean;
/** @example required_reviewers */
- readonly type: string;
+ type: string;
/** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- readonly reviewers?: readonly {
- readonly type?: components["schemas"]["deployment-reviewer-type"];
- readonly reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"];
+ reviewers?: {
+ type?: components["schemas"]["deployment-reviewer-type"];
+ reviewer?: components["schemas"]["simple-user"] | components["schemas"]["team"];
}[];
} | {
/** @example 3515 */
- readonly id: number;
+ id: number;
/** @example MDQ6R2F0ZTM1MTU= */
- readonly node_id: string;
+ node_id: string;
/** @example branch_policy */
- readonly type: string;
+ type: string;
})[];
- readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
+ deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
};
/**
* @description Whether or not a user who created the job is prevented from approving their own job.
* @example false
*/
- readonly "prevent-self-review": boolean;
+ "prevent-self-review": boolean;
/**
* Deployment branch policy
* @description Details of a deployment branch or tag policy.
*/
- readonly "deployment-branch-policy": {
+ "deployment-branch-policy": {
/**
* @description The unique identifier of the branch or tag policy.
* @example 361471
*/
- readonly id?: number;
+ id?: number;
/** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */
- readonly node_id?: string;
+ node_id?: string;
/**
* @description The name pattern that branches or tags must match in order to deploy to the environment.
* @example release/*
*/
- readonly name?: string;
+ name?: string;
/**
* @description Whether this rule targets a branch or tag.
* @example branch
* @enum {string}
*/
- readonly type?: "branch" | "tag";
+ type?: "branch" | "tag";
};
/** Deployment branch and tag policy name pattern */
- readonly "deployment-branch-policy-name-pattern-with-type": {
+ "deployment-branch-policy-name-pattern-with-type": {
/**
* @description The name pattern that branches or tags must match in order to deploy to the environment.
*
@@ -31002,16 +33987,16 @@ export type components = {
* For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
* @example release/*
*/
- readonly name: string;
+ name: string;
/**
* @description Whether this rule targets a branch or tag
* @example branch
* @enum {string}
*/
- readonly type?: "branch" | "tag";
+ type?: "branch" | "tag";
};
/** Deployment branch policy name pattern */
- readonly "deployment-branch-policy-name-pattern": {
+ "deployment-branch-policy-name-pattern": {
/**
* @description The name pattern that branches must match in order to deploy to the environment.
*
@@ -31019,231 +34004,231 @@ export type components = {
* For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).
* @example release/*
*/
- readonly name: string;
+ name: string;
};
/**
* Custom deployment protection rule app
* @description A GitHub App that is providing a custom deployment protection rule.
*/
- readonly "custom-deployment-rule-app": {
+ "custom-deployment-rule-app": {
/**
* @description The unique identifier of the deployment protection rule integration.
* @example 3515
*/
- readonly id: number;
+ id: number;
/**
* @description The slugified name of the deployment protection rule integration.
* @example my-custom-app
*/
- readonly slug: string;
+ slug: string;
/**
* @description The URL for the endpoint to get details about the app.
* @example https://api.github.com/apps/custom-app-slug
*/
- readonly integration_url: string;
+ integration_url: string;
/**
* @description The node ID for the deployment protection rule integration.
* @example MDQ6R2F0ZTM1MTU=
*/
- readonly node_id: string;
+ node_id: string;
};
/**
* Deployment protection rule
* @description Deployment protection rule
*/
- readonly "deployment-protection-rule": {
+ "deployment-protection-rule": {
/**
* @description The unique identifier for the deployment protection rule.
* @example 3515
*/
- readonly id: number;
+ id: number;
/**
* @description The node ID for the deployment protection rule.
* @example MDQ6R2F0ZTM1MTU=
*/
- readonly node_id: string;
+ node_id: string;
/**
* @description Whether the deployment protection rule is enabled for the environment.
* @example true
*/
- readonly enabled: boolean;
- readonly app: components["schemas"]["custom-deployment-rule-app"];
+ enabled: boolean;
+ app: components["schemas"]["custom-deployment-rule-app"];
};
/**
* Short Blob
* @description Short Blob
*/
- readonly "short-blob": {
- readonly url: string;
- readonly sha: string;
+ "short-blob": {
+ url: string;
+ sha: string;
};
/**
* Blob
* @description Blob
*/
- readonly blob: {
- readonly content: string;
- readonly encoding: string;
+ blob: {
+ content: string;
+ encoding: string;
/** Format: uri */
- readonly url: string;
- readonly sha: string;
- readonly size: number | null;
- readonly node_id: string;
- readonly highlighted_content?: string;
+ url: string;
+ sha: string;
+ size: number | null;
+ node_id: string;
+ highlighted_content?: string;
};
/**
* Git Commit
* @description Low-level Git commit operations within a repository
*/
- readonly "git-commit": {
+ "git-commit": {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
- readonly node_id: string;
+ sha: string;
+ node_id: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @description Identifying information for the git-user */
- readonly author: {
+ author: {
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly date: string;
+ date: string;
/**
* @description Git email address of the user
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
/**
* @description Name of the git user
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
};
/** @description Identifying information for the git-user */
- readonly committer: {
+ committer: {
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly date: string;
+ date: string;
/**
* @description Git email address of the user
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
/**
* @description Name of the git user
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
};
/**
* @description Message describing the purpose of the commit
* @example Fix #42
*/
- readonly message: string;
- readonly tree: {
+ message: string;
+ tree: {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly parents: readonly {
+ parents: {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
}[];
- readonly verification: {
- readonly verified: boolean;
- readonly reason: string;
- readonly signature: string | null;
- readonly payload: string | null;
- readonly verified_at?: string | null;
+ verification: {
+ verified: boolean;
+ reason: string;
+ signature: string | null;
+ payload: string | null;
+ verified_at: string | null;
};
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
};
/**
* Git Reference
* @description Git references within a repository
*/
- readonly "git-ref": {
- readonly ref: string;
- readonly node_id: string;
+ "git-ref": {
+ ref: string;
+ node_id: string;
/** Format: uri */
- readonly url: string;
- readonly object: {
- readonly type: string;
+ url: string;
+ object: {
+ type: string;
/**
* @description SHA for the reference
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
};
/**
* Git Tag
* @description Metadata for a Git tag
*/
- readonly "git-tag": {
+ "git-tag": {
/** @example MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== */
- readonly node_id: string;
+ node_id: string;
/**
* @description Name of the tag
* @example v0.0.1
*/
- readonly tag: string;
+ tag: string;
/** @example 940bd336248efae0f9ee5bc7b2d5c985887b16ac */
- readonly sha: string;
+ sha: string;
/**
* Format: uri
* @description URL for the tag
* @example https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac
*/
- readonly url: string;
+ url: string;
/**
* @description Message describing the purpose of the tag
* @example Initial public release
*/
- readonly message: string;
- readonly tagger: {
- readonly date: string;
- readonly email: string;
- readonly name: string;
+ message: string;
+ tagger: {
+ date: string;
+ email: string;
+ name: string;
};
- readonly object: {
- readonly sha: string;
- readonly type: string;
+ object: {
+ sha: string;
+ type: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly verification?: components["schemas"]["verification"];
+ verification?: components["schemas"]["verification"];
};
/**
* Git Tree
* @description The hierarchy between files in a Git repository.
*/
- readonly "git-tree": {
- readonly sha: string;
+ "git-tree": {
+ sha: string;
/** Format: uri */
- readonly url: string;
- readonly truncated: boolean;
+ url?: string;
+ truncated: boolean;
/**
* @description Objects specifying a tree structure
* @example [
@@ -31253,80 +34238,52 @@ export type components = {
* "type": "blob",
* "size": 30,
* "sha": "44b4fc6d56897b048c772eb4087f854f46256132",
- * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132",
- * "properties": {
- * "path": {
- * "type": "string"
- * },
- * "mode": {
- * "type": "string"
- * },
- * "type": {
- * "type": "string"
- * },
- * "size": {
- * "type": "integer"
- * },
- * "sha": {
- * "type": "string"
- * },
- * "url": {
- * "type": "string"
- * }
- * },
- * "required": [
- * "path",
- * "mode",
- * "type",
- * "sha",
- * "url",
- * "size"
- * ]
+ * "url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132"
* }
* ]
*/
- readonly tree: readonly {
+ tree: {
/** @example test/file.rb */
- readonly path?: string;
+ path: string;
/** @example 040000 */
- readonly mode?: string;
+ mode: string;
/** @example tree */
- readonly type?: string;
+ type: string;
/** @example 23f6827669e43831def8a7ad935069c8bd418261 */
- readonly sha?: string;
+ sha: string;
/** @example 12 */
- readonly size?: number;
+ size?: number;
/** @example https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 */
- readonly url?: string;
+ url?: string;
}[];
};
/** Hook Response */
- readonly "hook-response": {
- readonly code: number | null;
- readonly status: string | null;
- readonly message: string | null;
+ "hook-response": {
+ code: number | null;
+ status: string | null;
+ message: string | null;
};
/**
* Webhook
* @description Webhooks for repositories.
*/
- readonly hook: {
- readonly type: string;
+ hook: {
+ type: string;
/**
* @description Unique identifier of the webhook.
* @example 42
*/
- readonly id: number;
+ id: number;
/**
* @description The name of a valid service, use 'web' for a webhook.
* @example web
*/
- readonly name: string;
+ name: string;
/**
* @description Determines whether the hook is actually triggered on pushes.
* @example true
*/
- readonly active: boolean;
+ active: boolean;
/**
* @description Determines what events the hook is triggered for. Default: ['push'].
* @example [
@@ -31334,154 +34291,170 @@ export type components = {
* "pull_request"
* ]
*/
- readonly events: readonly string[];
- readonly config: components["schemas"]["webhook-config"];
+ events: string[];
+ config: components["schemas"]["webhook-config"];
/**
* Format: date-time
* @example 2011-09-06T20:39:23Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: date-time
* @example 2011-09-06T17:26:27Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/hooks/1
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/hooks/1/test
*/
- readonly test_url: string;
+ test_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/hooks/1/pings
*/
- readonly ping_url: string;
+ ping_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
*/
- readonly deliveries_url?: string;
- readonly last_response: components["schemas"]["hook-response"];
+ deliveries_url?: string;
+ last_response: components["schemas"]["hook-response"];
+ };
+ /**
+ * Check immutable releases
+ * @description Check immutable releases
+ */
+ "check-immutable-releases": {
+ /**
+ * @description Whether immutable releases are enabled for the repository.
+ * @example true
+ */
+ enabled: boolean;
+ /**
+ * @description Whether immutable releases are enforced by the repository owner.
+ * @example false
+ */
+ enforced_by_owner: boolean;
};
/**
* Import
* @description A repository import from an external source.
*/
- readonly import: {
- readonly vcs: string | null;
- readonly use_lfs?: boolean;
+ import: {
+ vcs: string | null;
+ use_lfs?: boolean;
/** @description The URL of the originating repository. */
- readonly vcs_url: string;
- readonly svc_root?: string;
- readonly tfvc_project?: string;
+ vcs_url: string;
+ svc_root?: string;
+ tfvc_project?: string;
/** @enum {string} */
- readonly status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth";
- readonly status_text?: string | null;
- readonly failed_step?: string | null;
- readonly error_message?: string | null;
- readonly import_percent?: number | null;
- readonly commit_count?: number | null;
- readonly push_percent?: number | null;
- readonly has_large_files?: boolean;
- readonly large_files_size?: number;
- readonly large_files_count?: number;
- readonly project_choices?: readonly {
- readonly vcs?: string;
- readonly tfvc_project?: string;
- readonly human_name?: string;
+ status: "auth" | "error" | "none" | "detecting" | "choose" | "auth_failed" | "importing" | "mapping" | "waiting_to_push" | "pushing" | "complete" | "setup" | "unknown" | "detection_found_multiple" | "detection_found_nothing" | "detection_needs_auth";
+ status_text?: string | null;
+ failed_step?: string | null;
+ error_message?: string | null;
+ import_percent?: number | null;
+ commit_count?: number | null;
+ push_percent?: number | null;
+ has_large_files?: boolean;
+ large_files_size?: number;
+ large_files_count?: number;
+ project_choices?: {
+ vcs?: string;
+ tfvc_project?: string;
+ human_name?: string;
}[];
- readonly message?: string;
- readonly authors_count?: number | null;
+ message?: string;
+ authors_count?: number | null;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: uri */
- readonly authors_url: string;
+ authors_url: string;
/** Format: uri */
- readonly repository_url: string;
- readonly svn_root?: string;
+ repository_url: string;
+ svn_root?: string;
};
/**
* Porter Author
* @description Porter Author
*/
- readonly "porter-author": {
- readonly id: number;
- readonly remote_id: string;
- readonly remote_name: string;
- readonly email: string;
- readonly name: string;
+ "porter-author": {
+ id: number;
+ remote_id: string;
+ remote_name: string;
+ email: string;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly import_url: string;
+ import_url: string;
};
/**
* Porter Large File
* @description Porter Large File
*/
- readonly "porter-large-file": {
- readonly ref_name: string;
- readonly path: string;
- readonly oid: string;
- readonly size: number;
+ "porter-large-file": {
+ ref_name: string;
+ path: string;
+ oid: string;
+ size: number;
};
/**
* Issue
* @description Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
*/
- readonly "nullable-issue": {
+ "nullable-issue": {
/** Format: int64 */
- readonly id: number;
- readonly node_id: string;
+ id: number;
+ node_id: string;
/**
* Format: uri
* @description URL for the issue
* @example https://api.github.com/repositories/42/issues/1
*/
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly repository_url: string;
- readonly labels_url: string;
+ repository_url: string;
+ labels_url: string;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* @description Number uniquely identifying the issue within its repository
* @example 42
*/
- readonly number: number;
+ number: number;
/**
* @description State of the issue; either 'open' or 'closed'
* @example open
*/
- readonly state: string;
+ state: string;
/**
* @description The reason for the current state
* @example not_planned
* @enum {string|null}
*/
- readonly state_reason?: "completed" | "reopened" | "not_planned" | null;
+ state_reason?: "completed" | "reopened" | "not_planned" | "duplicate" | null;
/**
* @description Title of the issue
* @example Widget creation fails in Safari on OS X 10.8
*/
- readonly title: string;
+ title: string;
/**
* @description Contents of the issue
* @example It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
*/
- readonly body?: string | null;
- readonly user: components["schemas"]["nullable-simple-user"];
+ body?: string | null;
+ user: components["schemas"]["nullable-simple-user"];
/**
* @description Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
* @example [
@@ -31489,1060 +34462,1033 @@ export type components = {
* "registration"
* ]
*/
- readonly labels: readonly (string | {
+ labels: (string | {
/** Format: int64 */
- readonly id?: number;
- readonly node_id?: string;
- /** Format: uri */
- readonly url?: string;
- readonly name?: string;
- readonly description?: string | null;
- readonly color?: string | null;
- readonly default?: boolean;
+ id?: number;
+ node_id?: string;
+ /** Format: uri */
+ url?: string;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
+ default?: boolean;
})[];
- readonly assignee: components["schemas"]["nullable-simple-user"];
- readonly assignees?: readonly components["schemas"]["simple-user"][] | null;
- readonly milestone: components["schemas"]["nullable-milestone"];
- readonly locked: boolean;
- readonly active_lock_reason?: string | null;
- readonly comments: number;
- readonly pull_request?: {
+ assignee: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][] | null;
+ milestone: components["schemas"]["nullable-milestone"];
+ locked: boolean;
+ active_lock_reason?: string | null;
+ comments: number;
+ pull_request?: {
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly diff_url: string | null;
+ diff_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly patch_url: string | null;
+ patch_url: string | null;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
};
/** Format: date-time */
- readonly closed_at: string | null;
+ closed_at: string | null;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
- readonly draft?: boolean;
- readonly closed_by?: components["schemas"]["nullable-simple-user"];
- readonly body_html?: string;
- readonly body_text?: string;
+ updated_at: string;
+ draft?: boolean;
+ closed_by?: components["schemas"]["nullable-simple-user"];
+ body_html?: string;
+ body_text?: string;
/** Format: uri */
- readonly timeline_url?: string;
- readonly repository?: components["schemas"]["repository"];
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
- readonly author_association: components["schemas"]["author-association"];
- readonly reactions?: components["schemas"]["reaction-rollup"];
- readonly sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ timeline_url?: string;
+ type?: components["schemas"]["issue-type"];
+ repository?: components["schemas"]["repository"];
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ author_association?: components["schemas"]["author-association"];
+ reactions?: components["schemas"]["reaction-rollup"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ /**
+ * Format: uri
+ * @description URL to get the parent issue of this issue, if it is a sub-issue
+ */
+ parent_issue_url?: string | null;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
} | null;
/**
* Issue Event Label
* @description Issue Event Label
*/
- readonly "issue-event-label": {
- readonly name: string | null;
- readonly color: string | null;
+ "issue-event-label": {
+ name: string | null;
+ color: string | null;
};
/** Issue Event Dismissed Review */
- readonly "issue-event-dismissed-review": {
- readonly state: string;
- readonly review_id: number;
- readonly dismissal_message: string | null;
- readonly dismissal_commit_id?: string | null;
+ "issue-event-dismissed-review": {
+ state: string;
+ review_id: number;
+ dismissal_message: string | null;
+ dismissal_commit_id?: string | null;
};
/**
* Issue Event Milestone
* @description Issue Event Milestone
*/
- readonly "issue-event-milestone": {
- readonly title: string;
+ "issue-event-milestone": {
+ title: string;
};
/**
* Issue Event Project Card
* @description Issue Event Project Card
*/
- readonly "issue-event-project-card": {
+ "issue-event-project-card": {
/** Format: uri */
- readonly url: string;
- readonly id: number;
+ url: string;
+ id: number;
/** Format: uri */
- readonly project_url: string;
- readonly project_id: number;
- readonly column_name: string;
- readonly previous_column_name?: string;
+ project_url: string;
+ project_id: number;
+ column_name: string;
+ previous_column_name?: string;
};
/**
* Issue Event Rename
* @description Issue Event Rename
*/
- readonly "issue-event-rename": {
- readonly from: string;
- readonly to: string;
+ "issue-event-rename": {
+ from: string;
+ to: string;
};
/**
* Issue Event
* @description Issue Event
*/
- readonly "issue-event": {
+ "issue-event": {
/**
* Format: int64
* @example 1
*/
- readonly id: number;
+ id: number;
/** @example MDEwOklzc3VlRXZlbnQx */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/issues/events/1
*/
- readonly url: string;
- readonly actor: components["schemas"]["nullable-simple-user"];
+ url: string;
+ actor: components["schemas"]["nullable-simple-user"];
/** @example closed */
- readonly event: string;
+ event: string;
/** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
- readonly commit_id: string | null;
+ commit_id: string | null;
/** @example https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e */
- readonly commit_url: string | null;
+ commit_url: string | null;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly created_at: string;
- readonly issue?: components["schemas"]["nullable-issue"];
- readonly label?: components["schemas"]["issue-event-label"];
- readonly assignee?: components["schemas"]["nullable-simple-user"];
- readonly assigner?: components["schemas"]["nullable-simple-user"];
- readonly review_requester?: components["schemas"]["nullable-simple-user"];
- readonly requested_reviewer?: components["schemas"]["nullable-simple-user"];
- readonly requested_team?: components["schemas"]["team"];
- readonly dismissed_review?: components["schemas"]["issue-event-dismissed-review"];
- readonly milestone?: components["schemas"]["issue-event-milestone"];
- readonly project_card?: components["schemas"]["issue-event-project-card"];
- readonly rename?: components["schemas"]["issue-event-rename"];
- readonly author_association?: components["schemas"]["author-association"];
- readonly lock_reason?: string | null;
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
+ created_at: string;
+ issue?: components["schemas"]["nullable-issue"];
+ label?: components["schemas"]["issue-event-label"];
+ assignee?: components["schemas"]["nullable-simple-user"];
+ assigner?: components["schemas"]["nullable-simple-user"];
+ review_requester?: components["schemas"]["nullable-simple-user"];
+ requested_reviewer?: components["schemas"]["nullable-simple-user"];
+ requested_team?: components["schemas"]["team"];
+ dismissed_review?: components["schemas"]["issue-event-dismissed-review"];
+ milestone?: components["schemas"]["issue-event-milestone"];
+ project_card?: components["schemas"]["issue-event-project-card"];
+ rename?: components["schemas"]["issue-event-rename"];
+ author_association?: components["schemas"]["author-association"];
+ lock_reason?: string | null;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
};
/**
* Labeled Issue Event
* @description Labeled Issue Event
*/
- readonly "labeled-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly label: {
- readonly name: string;
- readonly color: string;
+ "labeled-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ label: {
+ name: string;
+ color: string;
};
};
/**
* Unlabeled Issue Event
* @description Unlabeled Issue Event
*/
- readonly "unlabeled-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly label: {
- readonly name: string;
- readonly color: string;
+ "unlabeled-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ label: {
+ name: string;
+ color: string;
};
};
/**
* Assigned Issue Event
* @description Assigned Issue Event
*/
- readonly "assigned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["integration"];
- readonly assignee: components["schemas"]["simple-user"];
- readonly assigner: components["schemas"]["simple-user"];
+ "assigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["integration"];
+ assignee: components["schemas"]["simple-user"];
+ assigner: components["schemas"]["simple-user"];
};
/**
* Unassigned Issue Event
* @description Unassigned Issue Event
*/
- readonly "unassigned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly assignee: components["schemas"]["simple-user"];
- readonly assigner: components["schemas"]["simple-user"];
+ "unassigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
+ assigner: components["schemas"]["simple-user"];
};
/**
* Milestoned Issue Event
* @description Milestoned Issue Event
*/
- readonly "milestoned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly milestone: {
- readonly title: string;
+ "milestoned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ milestone: {
+ title: string;
};
};
/**
* Demilestoned Issue Event
* @description Demilestoned Issue Event
*/
- readonly "demilestoned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly milestone: {
- readonly title: string;
+ "demilestoned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ milestone: {
+ title: string;
};
};
/**
* Renamed Issue Event
* @description Renamed Issue Event
*/
- readonly "renamed-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly rename: {
- readonly from: string;
- readonly to: string;
+ "renamed-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ rename: {
+ from: string;
+ to: string;
};
};
/**
* Review Requested Issue Event
* @description Review Requested Issue Event
*/
- readonly "review-requested-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly review_requester: components["schemas"]["simple-user"];
- readonly requested_team?: components["schemas"]["team"];
- readonly requested_reviewer?: components["schemas"]["simple-user"];
+ "review-requested-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ review_requester: components["schemas"]["simple-user"];
+ requested_team?: components["schemas"]["team"];
+ requested_reviewer?: components["schemas"]["simple-user"];
};
/**
* Review Request Removed Issue Event
* @description Review Request Removed Issue Event
*/
- readonly "review-request-removed-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly review_requester: components["schemas"]["simple-user"];
- readonly requested_team?: components["schemas"]["team"];
- readonly requested_reviewer?: components["schemas"]["simple-user"];
+ "review-request-removed-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ review_requester: components["schemas"]["simple-user"];
+ requested_team?: components["schemas"]["team"];
+ requested_reviewer?: components["schemas"]["simple-user"];
};
/**
* Review Dismissed Issue Event
* @description Review Dismissed Issue Event
*/
- readonly "review-dismissed-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly dismissed_review: {
- readonly state: string;
- readonly review_id: number;
- readonly dismissal_message: string | null;
- readonly dismissal_commit_id?: string;
+ "review-dismissed-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ dismissed_review: {
+ state: string;
+ review_id: number;
+ dismissal_message: string | null;
+ dismissal_commit_id?: string;
};
};
/**
* Locked Issue Event
* @description Locked Issue Event
*/
- readonly "locked-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
+ "locked-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
/** @example "off-topic" */
- readonly lock_reason: string | null;
+ lock_reason: string | null;
};
/**
* Added to Project Issue Event
* @description Added to Project Issue Event
*/
- readonly "added-to-project-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly project_card?: {
- readonly id: number;
+ "added-to-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
/** Format: uri */
- readonly url: string;
- readonly project_id: number;
+ url: string;
+ project_id: number;
/** Format: uri */
- readonly project_url: string;
- readonly column_name: string;
- readonly previous_column_name?: string;
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
};
};
/**
* Moved Column in Project Issue Event
* @description Moved Column in Project Issue Event
*/
- readonly "moved-column-in-project-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly project_card?: {
- readonly id: number;
+ "moved-column-in-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
/** Format: uri */
- readonly url: string;
- readonly project_id: number;
+ url: string;
+ project_id: number;
/** Format: uri */
- readonly project_url: string;
- readonly column_name: string;
- readonly previous_column_name?: string;
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
};
};
/**
* Removed from Project Issue Event
* @description Removed from Project Issue Event
*/
- readonly "removed-from-project-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly project_card?: {
- readonly id: number;
+ "removed-from-project-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ project_card?: {
+ id: number;
/** Format: uri */
- readonly url: string;
- readonly project_id: number;
+ url: string;
+ project_id: number;
/** Format: uri */
- readonly project_url: string;
- readonly column_name: string;
- readonly previous_column_name?: string;
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
};
};
/**
* Converted Note to Issue Issue Event
* @description Converted Note to Issue Issue Event
*/
- readonly "converted-note-to-issue-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["integration"];
- readonly project_card?: {
- readonly id: number;
+ "converted-note-to-issue-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["integration"];
+ project_card?: {
+ id: number;
/** Format: uri */
- readonly url: string;
- readonly project_id: number;
+ url: string;
+ project_id: number;
/** Format: uri */
- readonly project_url: string;
- readonly column_name: string;
- readonly previous_column_name?: string;
+ project_url: string;
+ column_name: string;
+ previous_column_name?: string;
};
};
/**
* Issue Event for Issue
* @description Issue Event for Issue
*/
- readonly "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"];
- /**
- * Label
- * @description Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
- */
- readonly label: {
- /**
- * Format: int64
- * @description Unique identifier for the label.
- * @example 208045946
- */
- readonly id: number;
- /** @example MDU6TGFiZWwyMDgwNDU5NDY= */
- readonly node_id: string;
- /**
- * Format: uri
- * @description URL for the label
- * @example https://api.github.com/repositories/42/labels/bug
- */
- readonly url: string;
- /**
- * @description The name of the label.
- * @example bug
- */
- readonly name: string;
- /**
- * @description Optional description of the label, such as its purpose.
- * @example Something isn't working
- */
- readonly description: string | null;
- /**
- * @description 6-character hex code, without the leading #, identifying the color
- * @example FFFFFF
- */
- readonly color: string;
- /**
- * @description Whether this label comes by default in a new repository.
- * @example true
- */
- readonly default: boolean;
- };
+ "issue-event-for-issue": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["assigned-issue-event"] | components["schemas"]["unassigned-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"];
/**
* Timeline Comment Event
* @description Timeline Comment Event
*/
- readonly "timeline-comment-event": {
- readonly event: string;
- readonly actor: components["schemas"]["simple-user"];
+ "timeline-comment-event": {
+ event: string;
+ actor: components["schemas"]["simple-user"];
/**
* @description Unique identifier of the issue comment
* @example 42
*/
- readonly id: number;
- readonly node_id: string;
+ id: number;
+ node_id: string;
/**
* Format: uri
* @description URL for the issue comment
* @example https://api.github.com/repositories/42/issues/comments/1
*/
- readonly url: string;
+ url: string;
/**
* @description Contents of the issue comment
* @example What version of Safari were you using when you observed this bug?
*/
- readonly body?: string;
- readonly body_text?: string;
- readonly body_html?: string;
+ body?: string;
+ body_text?: string;
+ body_html?: string;
/** Format: uri */
- readonly html_url: string;
- readonly user: components["schemas"]["simple-user"];
+ html_url: string;
+ user: components["schemas"]["simple-user"];
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly issue_url: string;
- readonly author_association: components["schemas"]["author-association"];
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
- readonly reactions?: components["schemas"]["reaction-rollup"];
+ issue_url: string;
+ author_association: components["schemas"]["author-association"];
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ reactions?: components["schemas"]["reaction-rollup"];
+ pin?: components["schemas"]["nullable-pinned-issue-comment"];
};
/**
* Timeline Cross Referenced Event
* @description Timeline Cross Referenced Event
*/
- readonly "timeline-cross-referenced-event": {
- readonly event: string;
- readonly actor?: components["schemas"]["simple-user"];
+ "timeline-cross-referenced-event": {
+ event: string;
+ actor?: components["schemas"]["simple-user"];
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
- readonly source: {
- readonly type?: string;
- readonly issue?: components["schemas"]["issue"];
+ updated_at: string;
+ source: {
+ type?: string;
+ issue?: components["schemas"]["issue"];
};
};
/**
* Timeline Committed Event
* @description Timeline Committed Event
*/
- readonly "timeline-committed-event": {
- readonly event?: string;
+ "timeline-committed-event": {
+ event?: string;
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
- readonly node_id: string;
+ sha: string;
+ node_id: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @description Identifying information for the git-user */
- readonly author: {
+ author: {
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly date: string;
+ date: string;
/**
* @description Git email address of the user
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
/**
* @description Name of the git user
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
};
/** @description Identifying information for the git-user */
- readonly committer: {
+ committer: {
/**
* Format: date-time
* @description Timestamp of the commit
* @example 2014-08-09T08:02:04+12:00
*/
- readonly date: string;
+ date: string;
/**
* @description Git email address of the user
* @example monalisa.octocat@example.com
*/
- readonly email: string;
+ email: string;
/**
* @description Name of the git user
* @example Monalisa Octocat
*/
- readonly name: string;
+ name: string;
};
/**
* @description Message describing the purpose of the commit
* @example Fix #42
*/
- readonly message: string;
- readonly tree: {
+ message: string;
+ tree: {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly parents: readonly {
+ parents: {
/**
* @description SHA for the commit
* @example 7638417db6d59f3c431d3e1f261cc637155684cd
*/
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
}[];
- readonly verification: {
- readonly verified: boolean;
- readonly reason: string;
- readonly signature: string | null;
- readonly payload: string | null;
- readonly verified_at?: string | null;
+ verification: {
+ verified: boolean;
+ reason: string;
+ signature: string | null;
+ payload: string | null;
+ verified_at: string | null;
};
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
};
/**
* Timeline Reviewed Event
* @description Timeline Reviewed Event
*/
- readonly "timeline-reviewed-event": {
- readonly event: string;
+ "timeline-reviewed-event": {
+ event: string;
/**
* @description Unique identifier of the review
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */
- readonly node_id: string;
- readonly user: components["schemas"]["simple-user"];
+ node_id: string;
+ user: components["schemas"]["simple-user"];
/**
* @description The text of the review.
* @example This looks great.
*/
- readonly body: string | null;
+ body: string | null;
/** @example CHANGES_REQUESTED */
- readonly state: string;
+ state: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/12
*/
- readonly pull_request_url: string;
- readonly _links: {
- readonly html: {
- readonly href: string;
+ pull_request_url: string;
+ _links: {
+ html: {
+ href: string;
};
- readonly pull_request: {
- readonly href: string;
+ pull_request: {
+ href: string;
};
};
/** Format: date-time */
- readonly submitted_at?: string;
+ submitted_at?: string;
+ /** Format: date-time */
+ updated_at?: string | null;
/**
* @description A commit SHA for the review.
* @example 54bb654c9e6025347f57900a4a5c2313a96b8035
*/
- readonly commit_id: string;
- readonly body_html?: string;
- readonly body_text?: string;
- readonly author_association: components["schemas"]["author-association"];
+ commit_id: string;
+ body_html?: string;
+ body_text?: string;
+ author_association: components["schemas"]["author-association"];
};
/**
* Pull Request Review Comment
* @description Pull Request Review Comments are comments on a portion of the Pull Request's diff.
*/
- readonly "pull-request-review-comment": {
+ "pull-request-review-comment": {
/**
* @description URL for the pull request review comment
* @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
*/
- readonly url: string;
+ url: string;
/**
* Format: int64
* @description The ID of the pull request review to which the comment belongs.
* @example 42
*/
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: int64
* @description The ID of the pull request review comment.
* @example 1
*/
- readonly id: number;
+ id: number;
/**
* @description The node ID of the pull request review comment.
* @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw
*/
- readonly node_id: string;
+ node_id: string;
/**
* @description The diff of the line that the comment refers to.
* @example @@ -16,33 +16,40 @@ public class Connection : IConnection...
*/
- readonly diff_hunk: string;
+ diff_hunk: string;
/**
* @description The relative path of the file to which the comment applies.
* @example config/database.yaml
*/
- readonly path: string;
+ path: string;
/**
* @description The line index in the diff to which the comment applies. This field is closing down; use `line` instead.
* @example 1
*/
- readonly position?: number;
+ position?: number;
/**
* @description The index of the original line in the diff to which the comment applies. This field is closing down; use `original_line` instead.
* @example 4
*/
- readonly original_position?: number;
+ original_position?: number;
/**
* @description The SHA of the commit to which the comment applies.
* @example 6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly commit_id: string;
+ commit_id: string;
/**
* @description The SHA of the original commit to which the comment applies.
* @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840
*/
- readonly original_commit_id: string;
+ original_commit_id: string;
/**
* @description The comment ID to reply to.
* @example 8
*/
- readonly in_reply_to_id?: number;
- readonly user: components["schemas"]["simple-user"];
+ in_reply_to_id?: number;
+ user: components["schemas"]["nullable-simple-user"];
/**
* @description The text of the comment.
* @example We should probably include a check for null values here.
*/
- readonly body: string;
+ body: string;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description HTML URL for the pull request review comment.
* @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @description URL for the pull request that the review comment belongs to.
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1
*/
- readonly pull_request_url: string;
- readonly author_association: components["schemas"]["author-association"];
- readonly _links: {
- readonly self: {
+ pull_request_url: string;
+ author_association: components["schemas"]["author-association"];
+ _links: {
+ self: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
*/
- readonly href: string;
+ href: string;
};
- readonly html: {
+ html: {
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
*/
- readonly href: string;
+ href: string;
};
- readonly pull_request: {
+ pull_request: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1
*/
- readonly href: string;
+ href: string;
};
};
/**
* @description The first line of the range for a multi-line comment.
* @example 2
*/
- readonly start_line?: number | null;
+ start_line?: number | null;
/**
* @description The first line of the range for a multi-line comment.
* @example 2
*/
- readonly original_start_line?: number | null;
+ original_start_line?: number | null;
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
* @example 2
*/
- readonly line?: number;
+ line?: number;
/**
* @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
* @example 2
*/
- readonly original_line?: number;
+ original_line?: number;
/**
* @description The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
* @default RIGHT
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/**
* @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly subject_type?: "line" | "file";
- readonly reactions?: components["schemas"]["reaction-rollup"];
+ subject_type?: "line" | "file";
+ reactions?: components["schemas"]["reaction-rollup"];
/** @example "comment body
" */
- readonly body_html?: string;
+ body_html?: string;
/** @example "comment body" */
- readonly body_text?: string;
+ body_text?: string;
};
/**
* Timeline Line Commented Event
* @description Timeline Line Commented Event
*/
- readonly "timeline-line-commented-event": {
- readonly event?: string;
- readonly node_id?: string;
- readonly comments?: readonly components["schemas"]["pull-request-review-comment"][];
+ "timeline-line-commented-event": {
+ event?: string;
+ node_id?: string;
+ comments?: components["schemas"]["pull-request-review-comment"][];
};
/**
* Timeline Commit Commented Event
* @description Timeline Commit Commented Event
*/
- readonly "timeline-commit-commented-event": {
- readonly event?: string;
- readonly node_id?: string;
- readonly commit_id?: string;
- readonly comments?: readonly components["schemas"]["commit-comment"][];
+ "timeline-commit-commented-event": {
+ event?: string;
+ node_id?: string;
+ commit_id?: string;
+ comments?: components["schemas"]["commit-comment"][];
};
/**
* Timeline Assigned Issue Event
* @description Timeline Assigned Issue Event
*/
- readonly "timeline-assigned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly assignee: components["schemas"]["simple-user"];
+ "timeline-assigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
};
/**
* Timeline Unassigned Issue Event
* @description Timeline Unassigned Issue Event
*/
- readonly "timeline-unassigned-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly assignee: components["schemas"]["simple-user"];
+ "timeline-unassigned-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ assignee: components["schemas"]["simple-user"];
};
/**
* State Change Issue Event
* @description State Change Issue Event
*/
- readonly "state-change-issue-event": {
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly actor: components["schemas"]["simple-user"];
- readonly event: string;
- readonly commit_id: string | null;
- readonly commit_url: string | null;
- readonly created_at: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
- readonly state_reason?: string | null;
+ "state-change-issue-event": {
+ id: number;
+ node_id: string;
+ url: string;
+ actor: components["schemas"]["simple-user"];
+ event: string;
+ commit_id: string | null;
+ commit_url: string | null;
+ created_at: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
+ state_reason?: string | null;
};
/**
* Timeline Event
* @description Timeline Event
*/
- readonly "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"];
+ "timeline-issue-events": components["schemas"]["labeled-issue-event"] | components["schemas"]["unlabeled-issue-event"] | components["schemas"]["milestoned-issue-event"] | components["schemas"]["demilestoned-issue-event"] | components["schemas"]["renamed-issue-event"] | components["schemas"]["review-requested-issue-event"] | components["schemas"]["review-request-removed-issue-event"] | components["schemas"]["review-dismissed-issue-event"] | components["schemas"]["locked-issue-event"] | components["schemas"]["added-to-project-issue-event"] | components["schemas"]["moved-column-in-project-issue-event"] | components["schemas"]["removed-from-project-issue-event"] | components["schemas"]["converted-note-to-issue-issue-event"] | components["schemas"]["timeline-comment-event"] | components["schemas"]["timeline-cross-referenced-event"] | components["schemas"]["timeline-committed-event"] | components["schemas"]["timeline-reviewed-event"] | components["schemas"]["timeline-line-commented-event"] | components["schemas"]["timeline-commit-commented-event"] | components["schemas"]["timeline-assigned-issue-event"] | components["schemas"]["timeline-unassigned-issue-event"] | components["schemas"]["state-change-issue-event"];
/**
* Deploy Key
* @description An SSH key granting access to a single repository.
*/
- readonly "deploy-key": {
- readonly id: number;
- readonly key: string;
- readonly url: string;
- readonly title: string;
- readonly verified: boolean;
- readonly created_at: string;
- readonly read_only: boolean;
- readonly added_by?: string | null;
- readonly last_used?: string | null;
- readonly enabled?: boolean;
+ "deploy-key": {
+ id: number;
+ key: string;
+ url: string;
+ title: string;
+ verified: boolean;
+ created_at: string;
+ read_only: boolean;
+ added_by?: string | null;
+ /** Format: date-time */
+ last_used?: string | null;
+ enabled?: boolean;
};
/**
* Language
* @description Language
*/
- readonly language: {
- readonly [key: string]: number;
+ language: {
+ [key: string]: number;
};
/**
* License Content
* @description License Content
*/
- readonly "license-content": {
- readonly name: string;
- readonly path: string;
- readonly sha: string;
- readonly size: number;
+ "license-content": {
+ name: string;
+ path: string;
+ sha: string;
+ size: number;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly git_url: string | null;
+ git_url: string | null;
/** Format: uri */
- readonly download_url: string | null;
- readonly type: string;
- readonly content: string;
- readonly encoding: string;
- readonly _links: {
+ download_url: string | null;
+ type: string;
+ content: string;
+ encoding: string;
+ _links: {
/** Format: uri */
- readonly git: string | null;
+ git: string | null;
/** Format: uri */
- readonly html: string | null;
+ html: string | null;
/** Format: uri */
- readonly self: string;
+ self: string;
};
- readonly license: components["schemas"]["nullable-license-simple"];
+ license: components["schemas"]["nullable-license-simple"];
};
/**
* Merged upstream
* @description Results of a successful merge upstream request
*/
- readonly "merged-upstream": {
- readonly message?: string;
+ "merged-upstream": {
+ message?: string;
/** @enum {string} */
- readonly merge_type?: "merge" | "fast-forward" | "none";
- readonly base_branch?: string;
+ merge_type?: "merge" | "fast-forward" | "none";
+ base_branch?: string;
};
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/milestones/1
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/milestones/v1.0
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
*/
- readonly labels_url: string;
+ labels_url: string;
/** @example 1002604 */
- readonly id: number;
+ id: number;
/** @example MDk6TWlsZXN0b25lMTAwMjYwNA== */
- readonly node_id: string;
+ node_id: string;
/**
* @description The number of the milestone.
* @example 42
*/
- readonly number: number;
+ number: number;
/**
* @description The state of the milestone.
* @default open
* @example open
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/**
* @description The title of the milestone.
* @example v1.0
*/
- readonly title: string;
+ title: string;
/** @example Tracking milestone for version 1.0 */
- readonly description: string | null;
- readonly creator: components["schemas"]["nullable-simple-user"];
+ description: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
/** @example 4 */
- readonly open_issues: number;
+ open_issues: number;
/** @example 8 */
- readonly closed_issues: number;
+ closed_issues: number;
/**
* Format: date-time
* @example 2011-04-10T20:09:31Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2014-03-03T18:58:10Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: date-time
* @example 2013-02-12T13:22:01Z
*/
- readonly closed_at: string | null;
+ closed_at: string | null;
/**
* Format: date-time
* @example 2012-10-09T23:39:01Z
*/
- readonly due_on: string | null;
+ due_on: string | null;
};
/** Pages Source Hash */
- readonly "pages-source-hash": {
- readonly branch: string;
- readonly path: string;
+ "pages-source-hash": {
+ branch: string;
+ path: string;
};
/** Pages Https Certificate */
- readonly "pages-https-certificate": {
+ "pages-https-certificate": {
/**
* @example approved
* @enum {string}
*/
- readonly state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed";
+ state: "new" | "authorization_created" | "authorization_pending" | "authorized" | "authorization_revoked" | "issued" | "uploaded" | "approved" | "errored" | "bad_authz" | "destroy_pending" | "dns_changed";
/** @example Certificate is approved */
- readonly description: string;
+ description: string;
/**
* @description Array of the domain set and its alternate name (if it is configured)
* @example [
@@ -32550,1091 +35496,852 @@ export type components = {
* "www.example.com"
* ]
*/
- readonly domains: readonly string[];
+ domains: string[];
/** Format: date */
- readonly expires_at?: string;
+ expires_at?: string;
};
/**
* GitHub Pages
* @description The configuration for GitHub Pages for a repository.
*/
- readonly page: {
+ page: {
/**
* Format: uri
* @description The API address for accessing this Page resource.
* @example https://api.github.com/repos/github/hello-world/pages
*/
- readonly url: string;
+ url: string;
/**
* @description The status of the most recent build of the Page.
* @example built
* @enum {string|null}
*/
- readonly status: "built" | "building" | "errored" | null;
+ status: "built" | "building" | "errored" | null;
/**
* @description The Pages site's custom domain
* @example example.com
*/
- readonly cname: string | null;
+ cname: string | null;
/**
* @description The state if the domain is verified
* @example pending
* @enum {string|null}
*/
- readonly protected_domain_state?: "pending" | "verified" | "unverified" | null;
+ protected_domain_state?: "pending" | "verified" | "unverified" | null;
/**
* Format: date-time
* @description The timestamp when a pending domain becomes unverified.
*/
- readonly pending_domain_unverified_at?: string | null;
+ pending_domain_unverified_at?: string | null;
/**
* @description Whether the Page has a custom 404 page.
* @default false
* @example false
*/
- readonly custom_404: boolean;
+ custom_404: boolean;
/**
* Format: uri
* @description The web address the Page can be accessed from.
* @example https://example.com
*/
- readonly html_url?: string;
+ html_url?: string;
/**
* @description The process in which the Page will be built.
* @example legacy
* @enum {string|null}
*/
- readonly build_type?: "legacy" | "workflow" | null;
- readonly source?: components["schemas"]["pages-source-hash"];
+ build_type?: "legacy" | "workflow" | null;
+ source?: components["schemas"]["pages-source-hash"];
/**
* @description Whether the GitHub Pages site is publicly visible. If set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site.
* @example true
*/
- readonly public: boolean;
- readonly https_certificate?: components["schemas"]["pages-https-certificate"];
+ public: boolean;
+ https_certificate?: components["schemas"]["pages-https-certificate"];
/**
* @description Whether https is enabled on the domain
* @example true
*/
- readonly https_enforced?: boolean;
+ https_enforced?: boolean;
};
/**
* Page Build
* @description Page Build
*/
- readonly "page-build": {
+ "page-build": {
/** Format: uri */
- readonly url: string;
- readonly status: string;
- readonly error: {
- readonly message: string | null;
- };
- readonly pusher: components["schemas"]["nullable-simple-user"];
- readonly commit: string;
- readonly duration: number;
+ url: string;
+ status: string;
+ error: {
+ message: string | null;
+ };
+ pusher: components["schemas"]["nullable-simple-user"];
+ commit: string;
+ duration: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/**
* Page Build Status
* @description Page Build Status
*/
- readonly "page-build-status": {
+ "page-build-status": {
/**
* Format: uri
* @example https://api.github.com/repos/github/hello-world/pages/builds/latest
*/
- readonly url: string;
+ url: string;
/** @example queued */
- readonly status: string;
+ status: string;
};
/**
* GitHub Pages
* @description The GitHub Pages deployment status.
*/
- readonly "page-deployment": {
+ "page-deployment": {
/** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */
- readonly id: number | string;
+ id: number | string;
/**
* Format: uri
* @description The URI to monitor GitHub Pages deployment status.
* @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251
*/
- readonly status_url: string;
+ status_url: string;
/**
* Format: uri
* @description The URI to the deployed GitHub Pages.
* @example hello-world.github.io
*/
- readonly page_url: string;
+ page_url: string;
/**
* Format: uri
* @description The URI to the deployed GitHub Pages preview.
* @example monalisa-1231a2312sa32-23sda74.drafts.github.io
*/
- readonly preview_url?: string;
+ preview_url?: string;
};
/** GitHub Pages deployment status */
- readonly "pages-deployment-status": {
+ "pages-deployment-status": {
/**
* @description The current status of the deployment.
* @enum {string}
*/
- readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed";
+ status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed";
};
/**
* Pages Health Check Status
* @description Pages Health Check Status
*/
- readonly "pages-health-check": {
- readonly domain?: {
- readonly host?: string;
- readonly uri?: string;
- readonly nameservers?: string;
- readonly dns_resolves?: boolean;
- readonly is_proxied?: boolean | null;
- readonly is_cloudflare_ip?: boolean | null;
- readonly is_fastly_ip?: boolean | null;
- readonly is_old_ip_address?: boolean | null;
- readonly is_a_record?: boolean | null;
- readonly has_cname_record?: boolean | null;
- readonly has_mx_records_present?: boolean | null;
- readonly is_valid_domain?: boolean;
- readonly is_apex_domain?: boolean;
- readonly should_be_a_record?: boolean | null;
- readonly is_cname_to_github_user_domain?: boolean | null;
- readonly is_cname_to_pages_dot_github_dot_com?: boolean | null;
- readonly is_cname_to_fastly?: boolean | null;
- readonly is_pointed_to_github_pages_ip?: boolean | null;
- readonly is_non_github_pages_ip_present?: boolean | null;
- readonly is_pages_domain?: boolean;
- readonly is_served_by_pages?: boolean | null;
- readonly is_valid?: boolean;
- readonly reason?: string | null;
- readonly responds_to_https?: boolean;
- readonly enforces_https?: boolean;
- readonly https_error?: string | null;
- readonly is_https_eligible?: boolean | null;
- readonly caa_error?: string | null;
- };
- readonly alt_domain?: {
- readonly host?: string;
- readonly uri?: string;
- readonly nameservers?: string;
- readonly dns_resolves?: boolean;
- readonly is_proxied?: boolean | null;
- readonly is_cloudflare_ip?: boolean | null;
- readonly is_fastly_ip?: boolean | null;
- readonly is_old_ip_address?: boolean | null;
- readonly is_a_record?: boolean | null;
- readonly has_cname_record?: boolean | null;
- readonly has_mx_records_present?: boolean | null;
- readonly is_valid_domain?: boolean;
- readonly is_apex_domain?: boolean;
- readonly should_be_a_record?: boolean | null;
- readonly is_cname_to_github_user_domain?: boolean | null;
- readonly is_cname_to_pages_dot_github_dot_com?: boolean | null;
- readonly is_cname_to_fastly?: boolean | null;
- readonly is_pointed_to_github_pages_ip?: boolean | null;
- readonly is_non_github_pages_ip_present?: boolean | null;
- readonly is_pages_domain?: boolean;
- readonly is_served_by_pages?: boolean | null;
- readonly is_valid?: boolean;
- readonly reason?: string | null;
- readonly responds_to_https?: boolean;
- readonly enforces_https?: boolean;
- readonly https_error?: string | null;
- readonly is_https_eligible?: boolean | null;
- readonly caa_error?: string | null;
+ "pages-health-check": {
+ domain?: {
+ host?: string;
+ uri?: string;
+ nameservers?: string;
+ dns_resolves?: boolean;
+ is_proxied?: boolean | null;
+ is_cloudflare_ip?: boolean | null;
+ is_fastly_ip?: boolean | null;
+ is_old_ip_address?: boolean | null;
+ is_a_record?: boolean | null;
+ has_cname_record?: boolean | null;
+ has_mx_records_present?: boolean | null;
+ is_valid_domain?: boolean;
+ is_apex_domain?: boolean;
+ should_be_a_record?: boolean | null;
+ is_cname_to_github_user_domain?: boolean | null;
+ is_cname_to_pages_dot_github_dot_com?: boolean | null;
+ is_cname_to_fastly?: boolean | null;
+ is_pointed_to_github_pages_ip?: boolean | null;
+ is_non_github_pages_ip_present?: boolean | null;
+ is_pages_domain?: boolean;
+ is_served_by_pages?: boolean | null;
+ is_valid?: boolean;
+ reason?: string | null;
+ responds_to_https?: boolean;
+ enforces_https?: boolean;
+ https_error?: string | null;
+ is_https_eligible?: boolean | null;
+ caa_error?: string | null;
+ };
+ alt_domain?: {
+ host?: string;
+ uri?: string;
+ nameservers?: string;
+ dns_resolves?: boolean;
+ is_proxied?: boolean | null;
+ is_cloudflare_ip?: boolean | null;
+ is_fastly_ip?: boolean | null;
+ is_old_ip_address?: boolean | null;
+ is_a_record?: boolean | null;
+ has_cname_record?: boolean | null;
+ has_mx_records_present?: boolean | null;
+ is_valid_domain?: boolean;
+ is_apex_domain?: boolean;
+ should_be_a_record?: boolean | null;
+ is_cname_to_github_user_domain?: boolean | null;
+ is_cname_to_pages_dot_github_dot_com?: boolean | null;
+ is_cname_to_fastly?: boolean | null;
+ is_pointed_to_github_pages_ip?: boolean | null;
+ is_non_github_pages_ip_present?: boolean | null;
+ is_pages_domain?: boolean;
+ is_served_by_pages?: boolean | null;
+ is_valid?: boolean;
+ reason?: string | null;
+ responds_to_https?: boolean;
+ enforces_https?: boolean;
+ https_error?: string | null;
+ is_https_eligible?: boolean | null;
+ caa_error?: string | null;
} | null;
};
/**
* Pull Request
* @description Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary.
*/
- readonly "pull-request": {
+ "pull-request": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1347
*/
- readonly url: string;
+ url: string;
/**
* Format: int64
* @example 1
*/
- readonly id: number;
+ id: number;
/** @example MDExOlB1bGxSZXF1ZXN0MQ== */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/1347
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/1347.diff
*/
- readonly diff_url: string;
+ diff_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/1347.patch
*/
- readonly patch_url: string;
+ patch_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/issues/1347
*/
- readonly issue_url: string;
+ issue_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
*/
- readonly commits_url: string;
+ commits_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
*/
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @example https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} */
- readonly review_comment_url: string;
+ review_comment_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
*/
- readonly comments_url: string;
+ comments_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
*/
- readonly statuses_url: string;
+ statuses_url: string;
/**
* @description Number uniquely identifying the pull request within its repository.
* @example 42
*/
- readonly number: number;
+ number: number;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @example open
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @example true */
- readonly locked: boolean;
+ locked: boolean;
/**
* @description The title of the pull request.
* @example Amazing new feature
*/
- readonly title: string;
- readonly user: components["schemas"]["simple-user"];
+ title: string;
+ user: components["schemas"]["simple-user"];
/** @example Please pull these awesome changes */
- readonly body: string | null;
- readonly labels: readonly {
+ body: string | null;
+ labels: {
/** Format: int64 */
- readonly id: number;
- readonly node_id: string;
- readonly url: string;
- readonly name: string;
- readonly description: string | null;
- readonly color: string;
- readonly default: boolean;
+ id: number;
+ node_id: string;
+ url: string;
+ name: string;
+ description: string | null;
+ color: string;
+ default: boolean;
}[];
- readonly milestone: components["schemas"]["nullable-milestone"];
+ milestone: components["schemas"]["nullable-milestone"];
/** @example too heated */
- readonly active_lock_reason?: string | null;
+ active_lock_reason?: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly closed_at: string | null;
+ closed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly merged_at: string | null;
+ merged_at: string | null;
/** @example e5bd3914e2e596debea16f433f57875b5b90bcd6 */
- readonly merge_commit_sha: string | null;
- readonly assignee: components["schemas"]["nullable-simple-user"];
- readonly assignees?: readonly components["schemas"]["simple-user"][] | null;
- readonly requested_reviewers?: readonly components["schemas"]["simple-user"][] | null;
- readonly requested_teams?: readonly components["schemas"]["team-simple"][] | null;
- readonly head: {
- readonly label: string;
- readonly ref: string;
- readonly repo: components["schemas"]["repository"];
- readonly sha: string;
- readonly user: components["schemas"]["simple-user"];
- };
- readonly base: {
- readonly label: string;
- readonly ref: string;
- readonly repo: components["schemas"]["repository"];
- readonly sha: string;
- readonly user: components["schemas"]["simple-user"];
- };
- readonly _links: {
- readonly comments: components["schemas"]["link"];
- readonly commits: components["schemas"]["link"];
- readonly statuses: components["schemas"]["link"];
- readonly html: components["schemas"]["link"];
- readonly issue: components["schemas"]["link"];
- readonly review_comments: components["schemas"]["link"];
- readonly review_comment: components["schemas"]["link"];
- readonly self: components["schemas"]["link"];
- };
- readonly author_association: components["schemas"]["author-association"];
- readonly auto_merge: components["schemas"]["auto-merge"];
+ merge_commit_sha: string | null;
+ assignee: components["schemas"]["nullable-simple-user"];
+ assignees?: components["schemas"]["simple-user"][] | null;
+ requested_reviewers?: components["schemas"]["simple-user"][] | null;
+ requested_teams?: components["schemas"]["team-simple"][] | null;
+ head: {
+ label: string;
+ ref: string;
+ repo: components["schemas"]["repository"];
+ sha: string;
+ user: components["schemas"]["simple-user"];
+ };
+ base: {
+ label: string;
+ ref: string;
+ repo: components["schemas"]["repository"];
+ sha: string;
+ user: components["schemas"]["simple-user"];
+ };
+ _links: {
+ comments: components["schemas"]["link"];
+ commits: components["schemas"]["link"];
+ statuses: components["schemas"]["link"];
+ html: components["schemas"]["link"];
+ issue: components["schemas"]["link"];
+ review_comments: components["schemas"]["link"];
+ review_comment: components["schemas"]["link"];
+ self: components["schemas"]["link"];
+ };
+ author_association: components["schemas"]["author-association"];
+ auto_merge: components["schemas"]["auto-merge"];
/**
* @description Indicates whether or not the pull request is a draft.
* @example false
*/
- readonly draft?: boolean;
- readonly merged: boolean;
+ draft?: boolean;
+ merged: boolean;
/** @example true */
- readonly mergeable: boolean | null;
+ mergeable: boolean | null;
/** @example true */
- readonly rebaseable?: boolean | null;
+ rebaseable?: boolean | null;
/** @example clean */
- readonly mergeable_state: string;
- readonly merged_by: components["schemas"]["nullable-simple-user"];
+ mergeable_state: string;
+ merged_by: components["schemas"]["nullable-simple-user"];
/** @example 10 */
- readonly comments: number;
+ comments: number;
/** @example 0 */
- readonly review_comments: number;
+ review_comments: number;
/**
* @description Indicates whether maintainers can modify the pull request.
* @example true
*/
- readonly maintainer_can_modify: boolean;
+ maintainer_can_modify: boolean;
/** @example 3 */
- readonly commits: number;
+ commits: number;
/** @example 100 */
- readonly additions: number;
+ additions: number;
/** @example 3 */
- readonly deletions: number;
+ deletions: number;
/** @example 5 */
- readonly changed_files: number;
+ changed_files: number;
};
/**
* Pull Request Merge Result
* @description Pull Request Merge Result
*/
- readonly "pull-request-merge-result": {
- readonly sha: string;
- readonly merged: boolean;
- readonly message: string;
+ "pull-request-merge-result": {
+ sha: string;
+ merged: boolean;
+ message: string;
};
/**
* Pull Request Review Request
* @description Pull Request Review Request
*/
- readonly "pull-request-review-request": {
- readonly users: readonly components["schemas"]["simple-user"][];
- readonly teams: readonly components["schemas"]["team"][];
+ "pull-request-review-request": {
+ users: components["schemas"]["simple-user"][];
+ teams: components["schemas"]["team"][];
};
/**
* Pull Request Review
* @description Pull Request Reviews are reviews on pull requests.
*/
- readonly "pull-request-review": {
+ "pull-request-review": {
/**
* Format: int64
* @description Unique identifier of the review
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= */
- readonly node_id: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ node_id: string;
+ user: components["schemas"]["nullable-simple-user"];
/**
* @description The text of the review.
* @example This looks great.
*/
- readonly body: string;
+ body: string;
/** @example CHANGES_REQUESTED */
- readonly state: string;
+ state: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/12
*/
- readonly pull_request_url: string;
- readonly _links: {
- readonly html: {
- readonly href: string;
+ pull_request_url: string;
+ _links: {
+ html: {
+ href: string;
};
- readonly pull_request: {
- readonly href: string;
+ pull_request: {
+ href: string;
};
};
/** Format: date-time */
- readonly submitted_at?: string;
+ submitted_at?: string;
/**
* @description A commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.
* @example 54bb654c9e6025347f57900a4a5c2313a96b8035
*/
- readonly commit_id: string | null;
- readonly body_html?: string;
- readonly body_text?: string;
- readonly author_association: components["schemas"]["author-association"];
+ commit_id: string | null;
+ body_html?: string;
+ body_text?: string;
+ author_association: components["schemas"]["author-association"];
};
/**
* Legacy Review Comment
* @description Legacy Review Comment
*/
- readonly "review-comment": {
+ "review-comment": {
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
*/
- readonly url: string;
+ url: string;
/**
* Format: int64
* @example 42
*/
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: int64
* @example 10
*/
- readonly id: number;
+ id: number;
/** @example MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw */
- readonly node_id: string;
+ node_id: string;
/** @example @@ -16,33 +16,40 @@ public class Connection : IConnection... */
- readonly diff_hunk: string;
+ diff_hunk: string;
/** @example file1.txt */
- readonly path: string;
+ path: string;
/** @example 1 */
- readonly position: number | null;
+ position: number | null;
/** @example 4 */
- readonly original_position: number;
+ original_position: number;
/** @example 6dcb09b5b57875f334f61aebed695e2e4193db5e */
- readonly commit_id: string;
+ commit_id: string;
/** @example 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 */
- readonly original_commit_id: string;
+ original_commit_id: string;
/** @example 8 */
- readonly in_reply_to_id?: number;
- readonly user: components["schemas"]["nullable-simple-user"];
+ in_reply_to_id?: number;
+ user: components["schemas"]["nullable-simple-user"];
/** @example Great stuff */
- readonly body: string;
+ body: string;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-04-14T16:00:49Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World/pulls/1
*/
- readonly pull_request_url: string;
- readonly author_association: components["schemas"]["author-association"];
- readonly _links: {
- readonly self: components["schemas"]["link"];
- readonly html: components["schemas"]["link"];
- readonly pull_request: components["schemas"]["link"];
+ pull_request_url: string;
+ author_association: components["schemas"]["author-association"];
+ _links: {
+ self: components["schemas"]["link"];
+ html: components["schemas"]["link"];
+ pull_request: components["schemas"]["link"];
};
- readonly body_text?: string;
- readonly body_html?: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
+ body_text?: string;
+ body_html?: string;
+ reactions?: components["schemas"]["reaction-rollup"];
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment
* @example 2
*/
- readonly line?: number;
+ line?: number;
/**
* @description The original line of the blob to which the comment applies. The last line of the range for a multi-line comment
* @example 2
*/
- readonly original_line?: number;
+ original_line?: number;
/**
* @description The first line of the range for a multi-line comment.
* @example 2
*/
- readonly start_line?: number | null;
+ start_line?: number | null;
/**
* @description The original first line of the range for a multi-line comment.
* @example 2
*/
- readonly original_start_line?: number | null;
- };
- /**
- * Release Asset
- * @description Data related to a release.
- */
- readonly "release-asset": {
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly browser_download_url: string;
- readonly id: number;
- readonly node_id: string;
- /**
- * @description The file name of the asset.
- * @example Team Environment
- */
- readonly name: string;
- readonly label: string | null;
+ original_start_line?: number | null;
/**
- * @description State of the release asset.
+ * @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly state: "uploaded" | "open";
- readonly content_type: string;
- readonly size: number;
- readonly download_count: number;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: date-time */
- readonly updated_at: string;
- readonly uploader: components["schemas"]["nullable-simple-user"];
- };
- /**
- * Release
- * @description A release.
- */
- readonly release: {
- /** Format: uri */
- readonly url: string;
- /** Format: uri */
- readonly html_url: string;
- /** Format: uri */
- readonly assets_url: string;
- readonly upload_url: string;
- /** Format: uri */
- readonly tarball_url: string | null;
- /** Format: uri */
- readonly zipball_url: string | null;
- readonly id: number;
- readonly node_id: string;
- /**
- * @description The name of the tag.
- * @example v1.0.0
- */
- readonly tag_name: string;
- /**
- * @description Specifies the commitish value that determines where the Git tag is created from.
- * @example master
- */
- readonly target_commitish: string;
- readonly name: string | null;
- readonly body?: string | null;
- /**
- * @description true to create a draft (unpublished) release, false to create a published one.
- * @example false
- */
- readonly draft: boolean;
- /**
- * @description Whether to identify the release as a prerelease or a full release.
- * @example false
- */
- readonly prerelease: boolean;
- /** Format: date-time */
- readonly created_at: string;
- /** Format: date-time */
- readonly published_at: string | null;
- readonly author: components["schemas"]["simple-user"];
- readonly assets: readonly components["schemas"]["release-asset"][];
- readonly body_html?: string;
- readonly body_text?: string;
- readonly mentions_count?: number;
- /**
- * Format: uri
- * @description The URL of the release discussion.
- */
- readonly discussion_url?: string;
- readonly reactions?: components["schemas"]["reaction-rollup"];
+ subject_type?: "line" | "file";
};
/**
* Generated Release Notes Content
* @description Generated name and body describing a release
*/
- readonly "release-notes-content": {
+ "release-notes-content": {
/**
* @description The generated name of the release
* @example Release v1.0.0 is now available!
*/
- readonly name: string;
+ name: string;
/** @description The generated body describing the contents of the release supporting markdown formatting */
- readonly body: string;
+ body: string;
};
/**
* repository ruleset data for rule
* @description User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
*/
- readonly "repository-rule-ruleset-info": {
+ "repository-rule-ruleset-info": {
/**
* @description The type of source for the ruleset that includes this rule.
* @enum {string}
*/
- readonly ruleset_source_type?: "Repository" | "Organization";
+ ruleset_source_type?: "Repository" | "Organization";
/** @description The name of the source of the ruleset that includes this rule. */
- readonly ruleset_source?: string;
+ ruleset_source?: string;
/** @description The ID of the ruleset that includes this rule. */
- readonly ruleset_id?: number;
+ ruleset_id?: number;
};
/**
* Repository Rule
* @description A repository rule with ruleset details.
*/
- readonly "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]);
- readonly "secret-scanning-alert": {
- readonly number?: components["schemas"]["alert-number"];
- readonly created_at?: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
- readonly url?: components["schemas"]["alert-url"];
- readonly html_url?: components["schemas"]["alert-html-url"];
+ "repository-rule-detailed": (components["schemas"]["repository-rule-creation"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-update"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-deletion"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-linear-history"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-merge-queue"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-deployments"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-signatures"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-pull-request"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-required-status-checks"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-non-fast-forward"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-message-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-commit-author-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-committer-email-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-path-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-path-length"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-file-extension-restriction"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-max-file-size"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-code-scanning"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-copilot-code-review"] & components["schemas"]["repository-rule-ruleset-info"]);
+ "secret-scanning-alert": {
+ number?: components["schemas"]["alert-number"];
+ created_at?: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ url?: components["schemas"]["alert-url"];
+ html_url?: components["schemas"]["alert-html-url"];
/**
* Format: uri
* @description The REST API URL of the code locations for this alert.
*/
- readonly locations_url?: string;
- readonly state?: components["schemas"]["secret-scanning-alert-state"];
- readonly resolution?: components["schemas"]["secret-scanning-alert-resolution"];
+ locations_url?: string;
+ state?: components["schemas"]["secret-scanning-alert-state"];
+ resolution?: components["schemas"]["secret-scanning-alert-resolution"];
/**
* Format: date-time
* @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly resolved_at?: string | null;
- readonly resolved_by?: components["schemas"]["nullable-simple-user"];
+ resolved_at?: string | null;
+ resolved_by?: components["schemas"]["nullable-simple-user"];
/** @description An optional comment to resolve an alert. */
- readonly resolution_comment?: string | null;
+ resolution_comment?: string | null;
/** @description The type of secret that secret scanning detected. */
- readonly secret_type?: string;
+ secret_type?: string;
/**
* @description User-friendly name for the detected secret, matching the `secret_type`.
* For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
*/
- readonly secret_type_display_name?: string;
+ secret_type_display_name?: string;
/** @description The secret that was detected. */
- readonly secret?: string;
+ secret?: string;
/** @description Whether push protection was bypassed for the detected secret. */
- readonly push_protection_bypassed?: boolean | null;
- readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ push_protection_bypassed?: boolean | null;
+ push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
/**
* Format: date-time
* @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly push_protection_bypassed_at?: string | null;
- readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"];
+ push_protection_bypassed_at?: string | null;
+ push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"];
/** @description An optional comment when reviewing a push protection bypass. */
- readonly push_protection_bypass_request_reviewer_comment?: string | null;
+ push_protection_bypass_request_reviewer_comment?: string | null;
/** @description An optional comment when requesting a push protection bypass. */
- readonly push_protection_bypass_request_comment?: string | null;
+ push_protection_bypass_request_comment?: string | null;
/**
* Format: uri
* @description The URL to a push protection bypass request.
*/
- readonly push_protection_bypass_request_html_url?: string | null;
+ push_protection_bypass_request_html_url?: string | null;
/**
* @description The token status as of the latest validity check.
* @enum {string}
*/
- readonly validity?: "active" | "inactive" | "unknown";
+ validity?: "active" | "inactive" | "unknown";
/** @description Whether the detected secret was publicly leaked. */
- readonly publicly_leaked?: boolean | null;
+ publicly_leaked?: boolean | null;
/** @description Whether the detected secret was found in multiple repositories under the same organization or enterprise. */
- readonly multi_repo?: boolean | null;
- };
- /** @description An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. */
- readonly "secret-scanning-alert-resolution-comment": string | null;
- /** @description Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. */
- readonly "secret-scanning-location-commit": {
- /**
- * @description The file path in the repository
- * @example /example/secrets.txt
- */
- readonly path: string;
- /** @description Line number at which the secret starts in the file */
- readonly start_line: number;
- /** @description Line number at which the secret ends in the file */
- readonly end_line: number;
- /** @description The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII */
- readonly start_column: number;
- /** @description The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII */
- readonly end_column: number;
- /**
- * @description SHA-1 hash ID of the associated blob
- * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
- */
- readonly blob_sha: string;
- /** @description The API URL to get the associated blob resource */
- readonly blob_url: string;
- /**
- * @description SHA-1 hash ID of the associated commit
- * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
- */
- readonly commit_sha: string;
- /** @description The API URL to get the associated commit resource */
- readonly commit_url: string;
- };
- /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */
- readonly "secret-scanning-location-wiki-commit": {
- /**
- * @description The file path of the wiki page
- * @example /example/Home.md
- */
- readonly path: string;
- /** @description Line number at which the secret starts in the file */
- readonly start_line: number;
- /** @description Line number at which the secret ends in the file */
- readonly end_line: number;
- /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */
- readonly start_column: number;
- /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */
- readonly end_column: number;
- /**
- * @description SHA-1 hash ID of the associated blob
- * @example af5626b4a114abcb82d63db7c8082c3c4756e51b
- */
- readonly blob_sha: string;
- /**
- * @description The GitHub URL to get the associated wiki page
- * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5
- */
- readonly page_url: string;
- /**
- * @description SHA-1 hash ID of the associated commit
- * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5
- */
- readonly commit_sha: string;
- /**
- * @description The GitHub URL to get the associated wiki commit
- * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5
- */
- readonly commit_url: string;
- };
- /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */
- readonly "secret-scanning-location-issue-title": {
- /**
- * Format: uri
- * @description The API URL to get the issue where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
- */
- readonly issue_title_url: string;
- };
- /** @description Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. */
- readonly "secret-scanning-location-issue-body": {
- /**
- * Format: uri
- * @description The API URL to get the issue where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/issues/1347
- */
- readonly issue_body_url: string;
- };
- /** @description Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. */
- readonly "secret-scanning-location-issue-comment": {
- /**
- * Format: uri
- * @description The API URL to get the issue comment where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
- */
- readonly issue_comment_url: string;
- };
- /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */
- readonly "secret-scanning-location-discussion-title": {
- /**
- * Format: uri
- * @description The URL to the discussion where the secret was detected.
- * @example https://github.com/community/community/discussions/39082
- */
- readonly discussion_title_url: string;
- };
- /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */
- readonly "secret-scanning-location-discussion-body": {
- /**
- * Format: uri
- * @description The URL to the discussion where the secret was detected.
- * @example https://github.com/community/community/discussions/39082#discussion-4566270
- */
- readonly discussion_body_url: string;
- };
- /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */
- readonly "secret-scanning-location-discussion-comment": {
- /**
- * Format: uri
- * @description The API URL to get the discussion comment where the secret was detected.
- * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232
- */
- readonly discussion_comment_url: string;
- };
- /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */
- readonly "secret-scanning-location-pull-request-title": {
- /**
- * Format: uri
- * @description The API URL to get the pull request where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846
- */
- readonly pull_request_title_url: string;
- };
- /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */
- readonly "secret-scanning-location-pull-request-body": {
- /**
- * Format: uri
- * @description The API URL to get the pull request where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846
- */
- readonly pull_request_body_url: string;
- };
- /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */
- readonly "secret-scanning-location-pull-request-comment": {
- /**
- * Format: uri
- * @description The API URL to get the pull request comment where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451
- */
- readonly pull_request_comment_url: string;
- };
- /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */
- readonly "secret-scanning-location-pull-request-review": {
- /**
- * Format: uri
- * @description The API URL to get the pull request review where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80
- */
- readonly pull_request_review_url: string;
- };
- /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */
- readonly "secret-scanning-location-pull-request-review-comment": {
- /**
- * Format: uri
- * @description The API URL to get the pull request review comment where the secret was detected.
- * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12
- */
- readonly pull_request_review_comment_url: string;
- };
- readonly "secret-scanning-location": {
+ multi_repo?: boolean | null;
+ /** @description A boolean value representing whether or not alert is base64 encoded */
+ is_base64_encoded?: boolean | null;
+ first_location_detected?: components["schemas"]["nullable-secret-scanning-first-detected-location"];
+ /** @description A boolean value representing whether or not the token in the alert was detected in more than one location. */
+ has_more_locations?: boolean;
+ assigned_to?: components["schemas"]["nullable-simple-user"];
+ };
+ /** @description An optional comment when closing or reopening an alert. Cannot be updated or deleted. */
+ "secret-scanning-alert-resolution-comment": string | null;
+ /** @description The username of the user to assign to the alert. Set to `null` to unassign the alert. */
+ "secret-scanning-alert-assignee": string | null;
+ "secret-scanning-location": {
/**
* @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found.
* @example commit
* @enum {string}
*/
- readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment";
- readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"];
+ type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment";
+ details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"];
};
/**
* @description The reason for bypassing push protection.
* @enum {string}
*/
- readonly "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later";
- readonly "secret-scanning-push-protection-bypass": {
- readonly reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"];
+ "secret-scanning-push-protection-bypass-reason": "false_positive" | "used_in_tests" | "will_fix_later";
+ "secret-scanning-push-protection-bypass": {
+ reason?: components["schemas"]["secret-scanning-push-protection-bypass-reason"];
/**
* Format: date-time
* @description The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly expire_at?: string | null;
+ expire_at?: string | null;
/** @description The token type this bypass is for. */
- readonly token_type?: string;
+ token_type?: string;
};
/** @description Information on a single scan performed by secret scanning on the repository */
- readonly "secret-scanning-scan": {
+ "secret-scanning-scan": {
/** @description The type of scan */
- readonly type?: string;
+ type?: string;
/** @description The state of the scan. Either "completed", "running", or "pending" */
- readonly status?: string;
+ status?: string;
/**
* Format: date-time
* @description The time that the scan was completed. Empty if the scan is running
*/
- readonly completed_at?: string | null;
+ completed_at?: string | null;
/**
* Format: date-time
* @description The time that the scan was started. Empty if the scan is pending
*/
- readonly started_at?: string | null;
+ started_at?: string | null;
};
- readonly "secret-scanning-scan-history": {
- readonly incremental_scans?: readonly components["schemas"]["secret-scanning-scan"][];
- readonly pattern_update_scans?: readonly components["schemas"]["secret-scanning-scan"][];
- readonly backfill_scans?: readonly components["schemas"]["secret-scanning-scan"][];
- readonly custom_pattern_backfill_scans?: readonly (components["schemas"]["secret-scanning-scan"] & {
+ "secret-scanning-scan-history": {
+ incremental_scans?: components["schemas"]["secret-scanning-scan"][];
+ pattern_update_scans?: components["schemas"]["secret-scanning-scan"][];
+ backfill_scans?: components["schemas"]["secret-scanning-scan"][];
+ custom_pattern_backfill_scans?: (components["schemas"]["secret-scanning-scan"] & {
/** @description Name of the custom pattern for custom pattern scans */
- readonly pattern_name?: string;
+ pattern_name?: string;
/** @description Level at which the custom pattern is defined, one of "repository", "organization", or "enterprise" */
- readonly pattern_scope?: string;
+ pattern_scope?: string;
})[];
};
- readonly "repository-advisory-create": {
+ "repository-advisory-create": {
/** @description A short summary of the advisory. */
- readonly summary: string;
+ summary: string;
/** @description A detailed description of what the advisory impacts. */
- readonly description: string;
+ description: string;
/** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id?: string | null;
+ cve_id?: string | null;
/** @description A product affected by the vulnerability detailed in a repository security advisory. */
- readonly vulnerabilities: readonly {
+ vulnerabilities: {
/** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
/** @description The unique package name within its ecosystem. */
- readonly name?: string | null;
+ name?: string | null;
};
/** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range?: string | null;
+ vulnerable_version_range?: string | null;
/** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions?: string | null;
+ patched_versions?: string | null;
/** @description The functions in the package that are affected. */
- readonly vulnerable_functions?: readonly string[] | null;
+ vulnerable_functions?: string[] | null;
}[];
/** @description A list of Common Weakness Enumeration (CWE) IDs. */
- readonly cwe_ids?: readonly string[] | null;
+ cwe_ids?: string[] | null;
/** @description A list of users receiving credit for their participation in the security advisory. */
- readonly credits?: readonly {
+ credits?: {
/** @description The username of the user credited. */
- readonly login: string;
- readonly type: components["schemas"]["security-advisory-credit-types"];
+ login: string;
+ type: components["schemas"]["security-advisory-credit-types"];
}[] | null;
/**
* @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
* @enum {string|null}
*/
- readonly severity?: "critical" | "high" | "medium" | "low" | null;
+ severity?: "critical" | "high" | "medium" | "low" | null;
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
- readonly cvss_vector_string?: string | null;
+ cvss_vector_string?: string | null;
/**
* @description Whether to create a temporary private fork of the repository to collaborate on a fix.
* @default false
*/
- readonly start_private_fork: boolean;
+ start_private_fork: boolean;
};
- readonly "private-vulnerability-report-create": {
+ "private-vulnerability-report-create": {
/** @description A short summary of the advisory. */
- readonly summary: string;
+ summary: string;
/** @description A detailed description of what the advisory impacts. */
- readonly description: string;
+ description: string;
/** @description An array of products affected by the vulnerability detailed in a repository security advisory. */
- readonly vulnerabilities?: readonly {
+ vulnerabilities?: {
/** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
/** @description The unique package name within its ecosystem. */
- readonly name?: string | null;
+ name?: string | null;
};
/** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range?: string | null;
+ vulnerable_version_range?: string | null;
/** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions?: string | null;
+ patched_versions?: string | null;
/** @description The functions in the package that are affected. */
- readonly vulnerable_functions?: readonly string[] | null;
+ vulnerable_functions?: string[] | null;
}[] | null;
/** @description A list of Common Weakness Enumeration (CWE) IDs. */
- readonly cwe_ids?: readonly string[] | null;
+ cwe_ids?: string[] | null;
/**
* @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
* @enum {string|null}
*/
- readonly severity?: "critical" | "high" | "medium" | "low" | null;
+ severity?: "critical" | "high" | "medium" | "low" | null;
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
- readonly cvss_vector_string?: string | null;
+ cvss_vector_string?: string | null;
/**
* @description Whether to create a temporary private fork of the repository to collaborate on a fix.
* @default false
*/
- readonly start_private_fork: boolean;
+ start_private_fork: boolean;
};
- readonly "repository-advisory-update": {
+ "repository-advisory-update": {
/** @description A short summary of the advisory. */
- readonly summary?: string;
+ summary?: string;
/** @description A detailed description of what the advisory impacts. */
- readonly description?: string;
+ description?: string;
/** @description The Common Vulnerabilities and Exposures (CVE) ID. */
- readonly cve_id?: string | null;
+ cve_id?: string | null;
/** @description A product affected by the vulnerability detailed in a repository security advisory. */
- readonly vulnerabilities?: readonly {
+ vulnerabilities?: {
/** @description The name of the package affected by the vulnerability. */
- readonly package: {
- readonly ecosystem: components["schemas"]["security-advisory-ecosystems"];
+ package: {
+ ecosystem: components["schemas"]["security-advisory-ecosystems"];
/** @description The unique package name within its ecosystem. */
- readonly name?: string | null;
+ name?: string | null;
};
/** @description The range of the package versions affected by the vulnerability. */
- readonly vulnerable_version_range?: string | null;
+ vulnerable_version_range?: string | null;
/** @description The package version(s) that resolve the vulnerability. */
- readonly patched_versions?: string | null;
+ patched_versions?: string | null;
/** @description The functions in the package that are affected. */
- readonly vulnerable_functions?: readonly string[] | null;
+ vulnerable_functions?: string[] | null;
}[];
/** @description A list of Common Weakness Enumeration (CWE) IDs. */
- readonly cwe_ids?: readonly string[] | null;
+ cwe_ids?: string[] | null;
/** @description A list of users receiving credit for their participation in the security advisory. */
- readonly credits?: readonly {
+ credits?: {
/** @description The username of the user credited. */
- readonly login: string;
- readonly type: components["schemas"]["security-advisory-credit-types"];
+ login: string;
+ type: components["schemas"]["security-advisory-credit-types"];
}[] | null;
/**
* @description The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.
* @enum {string|null}
*/
- readonly severity?: "critical" | "high" | "medium" | "low" | null;
+ severity?: "critical" | "high" | "medium" | "low" | null;
/** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */
- readonly cvss_vector_string?: string | null;
+ cvss_vector_string?: string | null;
/**
* @description The state of the advisory.
* @enum {string}
*/
- readonly state?: "published" | "closed" | "draft";
+ state?: "published" | "closed" | "draft";
/** @description A list of usernames who have been granted write access to the advisory. */
- readonly collaborating_users?: readonly string[] | null;
+ collaborating_users?: string[] | null;
/** @description A list of team slugs which have been granted write access to the advisory. */
- readonly collaborating_teams?: readonly string[] | null;
+ collaborating_teams?: string[] | null;
};
/**
* Stargazer
* @description Stargazer
*/
- readonly stargazer: {
+ stargazer: {
/** Format: date-time */
- readonly starred_at: string;
- readonly user: components["schemas"]["nullable-simple-user"];
+ starred_at: string;
+ user: components["schemas"]["nullable-simple-user"];
};
/**
* Code Frequency Stat
* @description Code Frequency Stat
*/
- readonly "code-frequency-stat": readonly number[];
+ "code-frequency-stat": number[];
/**
* Commit Activity
* @description Commit Activity
*/
- readonly "commit-activity": {
+ "commit-activity": {
/**
* @example [
* 0,
@@ -33646,20 +36353,20 @@ export type components = {
* 0
* ]
*/
- readonly days: readonly number[];
+ days: number[];
/** @example 89 */
- readonly total: number;
+ total: number;
/** @example 1336280400 */
- readonly week: number;
+ week: number;
};
/**
* Contributor Activity
* @description Contributor Activity
*/
- readonly "contributor-activity": {
- readonly author: components["schemas"]["nullable-simple-user"];
+ "contributor-activity": {
+ author: components["schemas"]["nullable-simple-user"];
/** @example 135 */
- readonly total: number;
+ total: number;
/**
* @example [
* {
@@ -33670,486 +36377,475 @@ export type components = {
* }
* ]
*/
- readonly weeks: readonly {
- readonly w?: number;
- readonly a?: number;
- readonly d?: number;
- readonly c?: number;
+ weeks: {
+ w?: number;
+ a?: number;
+ d?: number;
+ c?: number;
}[];
};
/** Participation Stats */
- readonly "participation-stats": {
- readonly all: readonly number[];
- readonly owner: readonly number[];
+ "participation-stats": {
+ all: number[];
+ owner: number[];
};
/**
* Repository Invitation
* @description Repository invitations let you manage who you collaborate with.
*/
- readonly "repository-subscription": {
+ "repository-subscription": {
/**
* @description Determines if notifications should be received from this repository.
* @example true
*/
- readonly subscribed: boolean;
+ subscribed: boolean;
/** @description Determines if all notifications should be blocked from this repository. */
- readonly ignored: boolean;
- readonly reason: string | null;
+ ignored: boolean;
+ reason: string | null;
/**
* Format: date-time
* @example 2012-10-06T21:34:12Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example/subscription
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/example
*/
- readonly repository_url: string;
+ repository_url: string;
};
/**
* Tag
* @description Tag
*/
- readonly tag: {
+ tag: {
/** @example v0.1 */
- readonly name: string;
- readonly commit: {
- readonly sha: string;
+ name: string;
+ commit: {
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/zipball/v0.1
*/
- readonly zipball_url: string;
+ zipball_url: string;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World/tarball/v0.1
*/
- readonly tarball_url: string;
- readonly node_id: string;
- };
- /**
- * Tag protection
- * @description Tag protection
- */
- readonly "tag-protection": {
- /** @example 2 */
- readonly id?: number;
- /** @example 2011-01-26T19:01:12Z */
- readonly created_at?: string;
- /** @example 2011-01-26T19:01:12Z */
- readonly updated_at?: string;
- /** @example true */
- readonly enabled?: boolean;
- /** @example v1.* */
- readonly pattern: string;
+ tarball_url: string;
+ node_id: string;
};
/**
* Topic
* @description A topic aggregates entities that are related to a subject.
*/
- readonly topic: {
- readonly names: readonly string[];
+ topic: {
+ names: string[];
};
/** Traffic */
- readonly traffic: {
+ traffic: {
/** Format: date-time */
- readonly timestamp: string;
- readonly uniques: number;
- readonly count: number;
+ timestamp: string;
+ uniques: number;
+ count: number;
};
/**
* Clone Traffic
* @description Clone Traffic
*/
- readonly "clone-traffic": {
+ "clone-traffic": {
/** @example 173 */
- readonly count: number;
+ count: number;
/** @example 128 */
- readonly uniques: number;
- readonly clones: readonly components["schemas"]["traffic"][];
+ uniques: number;
+ clones: components["schemas"]["traffic"][];
};
/**
* Content Traffic
* @description Content Traffic
*/
- readonly "content-traffic": {
+ "content-traffic": {
/** @example /github/hubot */
- readonly path: string;
+ path: string;
/** @example github/hubot: A customizable life embetterment robot. */
- readonly title: string;
+ title: string;
/** @example 3542 */
- readonly count: number;
+ count: number;
/** @example 2225 */
- readonly uniques: number;
+ uniques: number;
};
/**
* Referrer Traffic
* @description Referrer Traffic
*/
- readonly "referrer-traffic": {
+ "referrer-traffic": {
/** @example Google */
- readonly referrer: string;
+ referrer: string;
/** @example 4 */
- readonly count: number;
+ count: number;
/** @example 3 */
- readonly uniques: number;
+ uniques: number;
};
/**
* View Traffic
* @description View Traffic
*/
- readonly "view-traffic": {
+ "view-traffic": {
/** @example 14850 */
- readonly count: number;
+ count: number;
/** @example 3782 */
- readonly uniques: number;
- readonly views: readonly components["schemas"]["traffic"][];
+ uniques: number;
+ views: components["schemas"]["traffic"][];
};
/** Search Result Text Matches */
- readonly "search-result-text-matches": readonly {
- readonly object_url?: string;
- readonly object_type?: string | null;
- readonly property?: string;
- readonly fragment?: string;
- readonly matches?: readonly {
- readonly text?: string;
- readonly indices?: readonly number[];
+ "search-result-text-matches": {
+ object_url?: string;
+ object_type?: string | null;
+ property?: string;
+ fragment?: string;
+ matches?: {
+ text?: string;
+ indices?: number[];
}[];
}[];
/**
* Code Search Result Item
* @description Code Search Result Item
*/
- readonly "code-search-result-item": {
- readonly name: string;
- readonly path: string;
- readonly sha: string;
+ "code-search-result-item": {
+ name: string;
+ path: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/** Format: uri */
- readonly html_url: string;
- readonly repository: components["schemas"]["minimal-repository"];
- readonly score: number;
- readonly file_size?: number;
- readonly language?: string | null;
+ html_url: string;
+ repository: components["schemas"]["minimal-repository"];
+ score: number;
+ file_size?: number;
+ language?: string | null;
/** Format: date-time */
- readonly last_modified_at?: string;
+ last_modified_at?: string;
/**
* @example [
* "73..77",
* "77..78"
* ]
*/
- readonly line_numbers?: readonly string[];
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
+ line_numbers?: string[];
+ text_matches?: components["schemas"]["search-result-text-matches"];
};
/**
* Commit Search Result Item
* @description Commit Search Result Item
*/
- readonly "commit-search-result-item": {
+ "commit-search-result-item": {
/** Format: uri */
- readonly url: string;
- readonly sha: string;
+ url: string;
+ sha: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: uri */
- readonly comments_url: string;
- readonly commit: {
- readonly author: {
- readonly name: string;
- readonly email: string;
+ comments_url: string;
+ commit: {
+ author: {
+ name: string;
+ email: string;
/** Format: date-time */
- readonly date: string;
+ date: string;
};
- readonly committer: components["schemas"]["nullable-git-user"];
- readonly comment_count: number;
- readonly message: string;
- readonly tree: {
- readonly sha: string;
+ committer: components["schemas"]["nullable-git-user"];
+ comment_count: number;
+ message: string;
+ tree: {
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Format: uri */
- readonly url: string;
- readonly verification?: components["schemas"]["verification"];
- };
- readonly author: components["schemas"]["nullable-simple-user"];
- readonly committer: components["schemas"]["nullable-git-user"];
- readonly parents: readonly {
- readonly url?: string;
- readonly html_url?: string;
- readonly sha?: string;
+ url: string;
+ verification?: components["schemas"]["verification"];
+ };
+ author: components["schemas"]["nullable-simple-user"];
+ committer: components["schemas"]["nullable-git-user"];
+ parents: {
+ url?: string;
+ html_url?: string;
+ sha?: string;
}[];
- readonly repository: components["schemas"]["minimal-repository"];
- readonly score: number;
- readonly node_id: string;
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
+ repository: components["schemas"]["minimal-repository"];
+ score: number;
+ node_id: string;
+ text_matches?: components["schemas"]["search-result-text-matches"];
};
/**
* Issue Search Result Item
* @description Issue Search Result Item
*/
- readonly "issue-search-result-item": {
+ "issue-search-result-item": {
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly repository_url: string;
- readonly labels_url: string;
+ repository_url: string;
+ labels_url: string;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly title: string;
- readonly locked: boolean;
- readonly active_lock_reason?: string | null;
- readonly assignees?: readonly components["schemas"]["simple-user"][] | null;
- readonly user: components["schemas"]["nullable-simple-user"];
- readonly labels: readonly {
+ id: number;
+ node_id: string;
+ number: number;
+ title: string;
+ locked: boolean;
+ active_lock_reason?: string | null;
+ assignees?: components["schemas"]["simple-user"][] | null;
+ user: components["schemas"]["nullable-simple-user"];
+ labels: {
/** Format: int64 */
- readonly id?: number;
- readonly node_id?: string;
- readonly url?: string;
- readonly name?: string;
- readonly color?: string;
- readonly default?: boolean;
- readonly description?: string | null;
+ id?: number;
+ node_id?: string;
+ url?: string;
+ name?: string;
+ color?: string;
+ default?: boolean;
+ description?: string | null;
}[];
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
- readonly state: string;
- readonly state_reason?: string | null;
- readonly assignee: components["schemas"]["nullable-simple-user"];
- readonly milestone: components["schemas"]["nullable-milestone"];
- readonly comments: number;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
+ state: string;
+ state_reason?: string | null;
+ assignee: components["schemas"]["nullable-simple-user"];
+ milestone: components["schemas"]["nullable-milestone"];
+ comments: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
- readonly pull_request?: {
+ closed_at: string | null;
+ text_matches?: components["schemas"]["search-result-text-matches"];
+ pull_request?: {
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly diff_url: string | null;
+ diff_url: string | null;
/** Format: uri */
- readonly html_url: string | null;
+ html_url: string | null;
/** Format: uri */
- readonly patch_url: string | null;
+ patch_url: string | null;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
};
- readonly body?: string;
- readonly score: number;
- readonly author_association: components["schemas"]["author-association"];
- readonly draft?: boolean;
- readonly repository?: components["schemas"]["repository"];
- readonly body_html?: string;
- readonly body_text?: string;
+ body?: string;
+ score: number;
+ author_association: components["schemas"]["author-association"];
+ draft?: boolean;
+ repository?: components["schemas"]["repository"];
+ body_html?: string;
+ body_text?: string;
/** Format: uri */
- readonly timeline_url?: string;
- readonly performed_via_github_app?: components["schemas"]["nullable-integration"];
- readonly reactions?: components["schemas"]["reaction-rollup"];
+ timeline_url?: string;
+ type?: components["schemas"]["issue-type"];
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ reactions?: components["schemas"]["reaction-rollup"];
};
/**
* Label Search Result Item
* @description Label Search Result Item
*/
- readonly "label-search-result-item": {
- readonly id: number;
- readonly node_id: string;
+ "label-search-result-item": {
+ id: number;
+ node_id: string;
/** Format: uri */
- readonly url: string;
- readonly name: string;
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly score: number;
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
+ url: string;
+ name: string;
+ color: string;
+ default: boolean;
+ description: string | null;
+ score: number;
+ text_matches?: components["schemas"]["search-result-text-matches"];
};
/**
* Repo Search Result Item
* @description Repo Search Result Item
*/
- readonly "repo-search-result-item": {
- readonly id: number;
- readonly node_id: string;
- readonly name: string;
- readonly full_name: string;
- readonly owner: components["schemas"]["nullable-simple-user"];
- readonly private: boolean;
+ "repo-search-result-item": {
+ id: number;
+ node_id: string;
+ name: string;
+ full_name: string;
+ owner: components["schemas"]["nullable-simple-user"];
+ private: boolean;
/** Format: uri */
- readonly html_url: string;
- readonly description: string | null;
- readonly fork: boolean;
+ html_url: string;
+ description: string | null;
+ fork: boolean;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: date-time */
- readonly pushed_at: string;
+ pushed_at: string;
/** Format: uri */
- readonly homepage: string | null;
- readonly size: number;
- readonly stargazers_count: number;
- readonly watchers_count: number;
- readonly language: string | null;
- readonly forks_count: number;
- readonly open_issues_count: number;
- readonly master_branch?: string;
- readonly default_branch: string;
- readonly score: number;
+ homepage: string | null;
+ size: number;
+ stargazers_count: number;
+ watchers_count: number;
+ language: string | null;
+ forks_count: number;
+ open_issues_count: number;
+ master_branch?: string;
+ default_branch: string;
+ score: number;
/** Format: uri */
- readonly forks_url: string;
- readonly keys_url: string;
- readonly collaborators_url: string;
+ forks_url: string;
+ keys_url: string;
+ collaborators_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri */
- readonly hooks_url: string;
- readonly issue_events_url: string;
+ hooks_url: string;
+ issue_events_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly assignees_url: string;
- readonly branches_url: string;
+ events_url: string;
+ assignees_url: string;
+ branches_url: string;
/** Format: uri */
- readonly tags_url: string;
- readonly blobs_url: string;
- readonly git_tags_url: string;
- readonly git_refs_url: string;
- readonly trees_url: string;
- readonly statuses_url: string;
+ tags_url: string;
+ blobs_url: string;
+ git_tags_url: string;
+ git_refs_url: string;
+ trees_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
- readonly commits_url: string;
- readonly git_commits_url: string;
- readonly comments_url: string;
- readonly issue_comment_url: string;
- readonly contents_url: string;
- readonly compare_url: string;
+ subscription_url: string;
+ commits_url: string;
+ git_commits_url: string;
+ comments_url: string;
+ issue_comment_url: string;
+ contents_url: string;
+ compare_url: string;
/** Format: uri */
- readonly merges_url: string;
- readonly archive_url: string;
+ merges_url: string;
+ archive_url: string;
/** Format: uri */
- readonly downloads_url: string;
- readonly issues_url: string;
- readonly pulls_url: string;
- readonly milestones_url: string;
- readonly notifications_url: string;
- readonly labels_url: string;
- readonly releases_url: string;
+ downloads_url: string;
+ issues_url: string;
+ pulls_url: string;
+ milestones_url: string;
+ notifications_url: string;
+ labels_url: string;
+ releases_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly git_url: string;
- readonly ssh_url: string;
- readonly clone_url: string;
+ deployments_url: string;
+ git_url: string;
+ ssh_url: string;
+ clone_url: string;
/** Format: uri */
- readonly svn_url: string;
- readonly forks: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly topics?: readonly string[];
+ svn_url: string;
+ forks: number;
+ open_issues: number;
+ watchers: number;
+ topics?: string[];
/** Format: uri */
- readonly mirror_url: string | null;
- readonly has_issues: boolean;
- readonly has_projects: boolean;
- readonly has_pages: boolean;
- readonly has_wiki: boolean;
- readonly has_downloads: boolean;
- readonly has_discussions?: boolean;
- readonly archived: boolean;
+ mirror_url: string | null;
+ has_issues: boolean;
+ has_projects: boolean;
+ has_pages: boolean;
+ has_wiki: boolean;
+ has_downloads: boolean;
+ has_discussions?: boolean;
+ has_pull_requests?: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ archived: boolean;
/** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ disabled: boolean;
/** @description The repository visibility: public, private, or internal. */
- readonly visibility?: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
- readonly pull: boolean;
- };
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
- readonly temp_clone_token?: string;
- readonly allow_merge_commit?: boolean;
- readonly allow_squash_merge?: boolean;
- readonly allow_rebase_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_forking?: boolean;
- readonly is_template?: boolean;
+ visibility?: string;
+ license: components["schemas"]["nullable-license-simple"];
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ push: boolean;
+ triage?: boolean;
+ pull: boolean;
+ };
+ text_matches?: components["schemas"]["search-result-text-matches"];
+ temp_clone_token?: string;
+ allow_merge_commit?: boolean;
+ allow_squash_merge?: boolean;
+ allow_rebase_merge?: boolean;
+ allow_auto_merge?: boolean;
+ delete_branch_on_merge?: boolean;
+ allow_forking?: boolean;
+ is_template?: boolean;
/** @example false */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
/**
* Topic Search Result Item
* @description Topic Search Result Item
*/
- readonly "topic-search-result-item": {
- readonly name: string;
- readonly display_name: string | null;
- readonly short_description: string | null;
- readonly description: string | null;
- readonly created_by: string | null;
- readonly released: string | null;
+ "topic-search-result-item": {
+ name: string;
+ display_name: string | null;
+ short_description: string | null;
+ description: string | null;
+ created_by: string | null;
+ released: string | null;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly updated_at: string;
- readonly featured: boolean;
- readonly curated: boolean;
- readonly score: number;
- readonly repository_count?: number | null;
+ updated_at: string;
+ featured: boolean;
+ curated: boolean;
+ score: number;
+ repository_count?: number | null;
/** Format: uri */
- readonly logo_url?: string | null;
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
- readonly related?: readonly {
- readonly topic_relation?: {
- readonly id?: number;
- readonly name?: string;
- readonly topic_id?: number;
- readonly relation_type?: string;
+ logo_url?: string | null;
+ text_matches?: components["schemas"]["search-result-text-matches"];
+ related?: {
+ topic_relation?: {
+ id?: number;
+ name?: string;
+ topic_id?: number;
+ relation_type?: string;
};
}[] | null;
- readonly aliases?: readonly {
- readonly topic_relation?: {
- readonly id?: number;
- readonly name?: string;
- readonly topic_id?: number;
- readonly relation_type?: string;
+ aliases?: {
+ topic_relation?: {
+ id?: number;
+ name?: string;
+ topic_id?: number;
+ relation_type?: string;
};
}[] | null;
};
@@ -34157,466 +36853,466 @@ export type components = {
* User Search Result Item
* @description User Search Result Item
*/
- readonly "user-search-result-item": {
- readonly login: string;
+ "user-search-result-item": {
+ login: string;
/** Format: int64 */
- readonly id: number;
- readonly node_id: string;
+ id: number;
+ node_id: string;
/** Format: uri */
- readonly avatar_url: string;
- readonly gravatar_id: string | null;
+ avatar_url: string;
+ gravatar_id: string | null;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: uri */
- readonly followers_url: string;
+ followers_url: string;
/** Format: uri */
- readonly subscriptions_url: string;
+ subscriptions_url: string;
/** Format: uri */
- readonly organizations_url: string;
+ organizations_url: string;
/** Format: uri */
- readonly repos_url: string;
+ repos_url: string;
/** Format: uri */
- readonly received_events_url: string;
- readonly type: string;
- readonly score: number;
- readonly following_url: string;
- readonly gists_url: string;
- readonly starred_url: string;
- readonly events_url: string;
- readonly public_repos?: number;
- readonly public_gists?: number;
- readonly followers?: number;
- readonly following?: number;
+ received_events_url: string;
+ type: string;
+ score: number;
+ following_url: string;
+ gists_url: string;
+ starred_url: string;
+ events_url: string;
+ public_repos?: number;
+ public_gists?: number;
+ followers?: number;
+ following?: number;
/** Format: date-time */
- readonly created_at?: string;
+ created_at?: string;
/** Format: date-time */
- readonly updated_at?: string;
- readonly name?: string | null;
- readonly bio?: string | null;
+ updated_at?: string;
+ name?: string | null;
+ bio?: string | null;
/** Format: email */
- readonly email?: string | null;
- readonly location?: string | null;
- readonly site_admin: boolean;
- readonly hireable?: boolean | null;
- readonly text_matches?: components["schemas"]["search-result-text-matches"];
- readonly blog?: string | null;
- readonly company?: string | null;
+ email?: string | null;
+ location?: string | null;
+ site_admin: boolean;
+ hireable?: boolean | null;
+ text_matches?: components["schemas"]["search-result-text-matches"];
+ blog?: string | null;
+ company?: string | null;
/** Format: date-time */
- readonly suspended_at?: string | null;
- readonly user_view_type?: string;
+ suspended_at?: string | null;
+ user_view_type?: string;
};
/**
* Private User
* @description Private User
*/
- readonly "private-user": {
+ "private-user": {
/** @example octocat */
- readonly login: string;
+ login: string;
/**
* Format: int64
* @example 1
*/
- readonly id: number;
+ id: number;
/**
* @description discriminator enum property added by openapi-typescript
* @enum {string}
*/
- readonly user_view_type: "private";
+ user_view_type: "private";
/** @example MDQ6VXNlcjE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://github.com/images/error/octocat_happy.gif
*/
- readonly avatar_url: string;
+ avatar_url: string;
/** @example 41d064eb2195891e12d0413f63227ea7 */
- readonly gravatar_id: string | null;
+ gravatar_id: string | null;
/**
* Format: uri
* @example https://api.github.com/users/octocat
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://github.com/octocat
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/followers
*/
- readonly followers_url: string;
+ followers_url: string;
/** @example https://api.github.com/users/octocat/following{/other_user} */
- readonly following_url: string;
+ following_url: string;
/** @example https://api.github.com/users/octocat/gists{/gist_id} */
- readonly gists_url: string;
+ gists_url: string;
/** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */
- readonly starred_url: string;
+ starred_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/subscriptions
*/
- readonly subscriptions_url: string;
+ subscriptions_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/orgs
*/
- readonly organizations_url: string;
+ organizations_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/repos
*/
- readonly repos_url: string;
+ repos_url: string;
/** @example https://api.github.com/users/octocat/events{/privacy} */
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example https://api.github.com/users/octocat/received_events
*/
- readonly received_events_url: string;
+ received_events_url: string;
/** @example User */
- readonly type: string;
- readonly site_admin: boolean;
+ type: string;
+ site_admin: boolean;
/** @example monalisa octocat */
- readonly name: string | null;
+ name: string | null;
/** @example GitHub */
- readonly company: string | null;
+ company: string | null;
/** @example https://github.com/blog */
- readonly blog: string | null;
+ blog: string | null;
/** @example San Francisco */
- readonly location: string | null;
+ location: string | null;
/**
* Format: email
* @example octocat@github.com
*/
- readonly email: string | null;
+ email: string | null;
/**
* Format: email
* @example octocat@github.com
*/
- readonly notification_email?: string | null;
- readonly hireable: boolean | null;
+ notification_email?: string | null;
+ hireable: boolean | null;
/** @example There once was... */
- readonly bio: string | null;
+ bio: string | null;
/** @example monalisa */
- readonly twitter_username?: string | null;
+ twitter_username?: string | null;
/** @example 2 */
- readonly public_repos: number;
+ public_repos: number;
/** @example 1 */
- readonly public_gists: number;
+ public_gists: number;
/** @example 20 */
- readonly followers: number;
+ followers: number;
/** @example 0 */
- readonly following: number;
+ following: number;
/**
* Format: date-time
* @example 2008-01-14T04:33:35Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2008-01-14T04:33:35Z
*/
- readonly updated_at: string;
+ updated_at: string;
/** @example 81 */
- readonly private_gists: number;
+ private_gists: number;
/** @example 100 */
- readonly total_private_repos: number;
+ total_private_repos: number;
/** @example 100 */
- readonly owned_private_repos: number;
+ owned_private_repos: number;
/** @example 10000 */
- readonly disk_usage: number;
+ disk_usage: number;
/** @example 8 */
- readonly collaborators: number;
+ collaborators: number;
/** @example true */
- readonly two_factor_authentication: boolean;
- readonly plan?: {
- readonly collaborators: number;
- readonly name: string;
- readonly space: number;
- readonly private_repos: number;
+ two_factor_authentication: boolean;
+ plan?: {
+ collaborators: number;
+ name: string;
+ space: number;
+ private_repos: number;
};
- readonly business_plus?: boolean;
- readonly ldap_dn?: string;
+ business_plus?: boolean;
+ ldap_dn?: string;
};
/**
* Codespaces Secret
* @description Secrets for a GitHub Codespace.
*/
- readonly "codespaces-secret": {
+ "codespaces-secret": {
/**
* @description The name of the secret
* @example SECRET_NAME
*/
- readonly name: string;
+ name: string;
/**
* Format: date-time
* @description The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* @description The type of repositories in the organization that the secret is visible to
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/**
* Format: uri
* @description The API URL at which the list of repositories this secret is visible to can be retrieved
* @example https://api.github.com/user/secrets/SECRET_NAME/repositories
*/
- readonly selected_repositories_url: string;
+ selected_repositories_url: string;
};
/**
* CodespacesUserPublicKey
* @description The public key used for setting user Codespaces' Secrets.
*/
- readonly "codespaces-user-public-key": {
+ "codespaces-user-public-key": {
/**
* @description The identifier for the key.
* @example 1234567
*/
- readonly key_id: string;
+ key_id: string;
/**
* @description The Base64 encoded public key.
* @example hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=
*/
- readonly key: string;
+ key: string;
};
/**
* Fetches information about an export of a codespace.
* @description An export of a codespace. Also, latest export details for a codespace can be fetched with id = latest
*/
- readonly "codespace-export-details": {
+ "codespace-export-details": {
/**
* @description State of the latest export
* @example succeeded | failed | in_progress
*/
- readonly state?: string | null;
+ state?: string | null;
/**
* Format: date-time
* @description Completion time of the last export operation
* @example 2021-01-01T19:01:12Z
*/
- readonly completed_at?: string | null;
+ completed_at?: string | null;
/**
* @description Name of the exported branch
* @example codespace-monalisa-octocat-hello-world-g4wpq6h95q
*/
- readonly branch?: string | null;
+ branch?: string | null;
/**
* @description Git commit SHA of the exported branch
* @example fd95a81ca01e48ede9f39c799ecbcef817b8a3b2
*/
- readonly sha?: string | null;
+ sha?: string | null;
/**
* @description Id for the export details
* @example latest
*/
- readonly id?: string;
+ id?: string;
/**
* @description Url for fetching export details
* @example https://api.github.com/user/codespaces/:name/exports/latest
*/
- readonly export_url?: string;
+ export_url?: string;
/**
* @description Web url for the exported branch
* @example https://github.com/octocat/hello-world/tree/:branch
*/
- readonly html_url?: string | null;
+ html_url?: string | null;
};
/**
* Codespace
* @description A codespace.
*/
- readonly "codespace-with-full-repository": {
+ "codespace-with-full-repository": {
/**
* Format: int64
* @example 1
*/
- readonly id: number;
+ id: number;
/**
* @description Automatically generated name of this codespace.
* @example monalisa-octocat-hello-world-g4wpq6h95q
*/
- readonly name: string;
+ name: string;
/**
* @description Display name for this codespace.
* @example bookish space pancake
*/
- readonly display_name?: string | null;
+ display_name?: string | null;
/**
* @description UUID identifying this codespace's environment.
* @example 26a7c758-7299-4a73-b978-5a92a7ae98a0
*/
- readonly environment_id: string | null;
- readonly owner: components["schemas"]["simple-user"];
- readonly billable_owner: components["schemas"]["simple-user"];
- readonly repository: components["schemas"]["full-repository"];
- readonly machine: components["schemas"]["nullable-codespace-machine"];
+ environment_id: string | null;
+ owner: components["schemas"]["simple-user"];
+ billable_owner: components["schemas"]["simple-user"];
+ repository: components["schemas"]["full-repository"];
+ machine: components["schemas"]["nullable-codespace-machine"];
/**
* @description Path to devcontainer.json from repo root used to create Codespace.
* @example .devcontainer/example/devcontainer.json
*/
- readonly devcontainer_path?: string | null;
+ devcontainer_path?: string | null;
/**
* @description Whether the codespace was created from a prebuild.
* @example false
*/
- readonly prebuild: boolean | null;
+ prebuild: boolean | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: date-time
* @description Last known time this codespace was started.
* @example 2011-01-26T19:01:12Z
*/
- readonly last_used_at: string;
+ last_used_at: string;
/**
* @description State of this codespace.
* @example Available
* @enum {string}
*/
- readonly state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding";
+ state: "Unknown" | "Created" | "Queued" | "Provisioning" | "Available" | "Awaiting" | "Unavailable" | "Deleted" | "Moved" | "Shutdown" | "Archived" | "Starting" | "ShuttingDown" | "Failed" | "Exporting" | "Updating" | "Rebuilding";
/**
* Format: uri
* @description API URL for this codespace.
*/
- readonly url: string;
+ url: string;
/** @description Details about the codespace's git repository. */
- readonly git_status: {
+ git_status: {
/**
* @description The number of commits the local repository is ahead of the remote.
* @example 0
*/
- readonly ahead?: number;
+ ahead?: number;
/**
* @description The number of commits the local repository is behind the remote.
* @example 0
*/
- readonly behind?: number;
+ behind?: number;
/** @description Whether the local repository has unpushed changes. */
- readonly has_unpushed_changes?: boolean;
+ has_unpushed_changes?: boolean;
/** @description Whether the local repository has uncommitted changes. */
- readonly has_uncommitted_changes?: boolean;
+ has_uncommitted_changes?: boolean;
/**
* @description The current branch (or SHA if in detached HEAD state) of the local repository.
* @example main
*/
- readonly ref?: string;
+ ref?: string;
};
/**
* @description The initally assigned location of a new codespace.
* @example WestUs2
* @enum {string}
*/
- readonly location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2";
+ location: "EastUs" | "SouthEastAsia" | "WestEurope" | "WestUs2";
/**
* @description The number of minutes of inactivity after which this codespace will be automatically stopped.
* @example 60
*/
- readonly idle_timeout_minutes: number | null;
+ idle_timeout_minutes: number | null;
/**
* Format: uri
* @description URL to access this codespace on the web.
*/
- readonly web_url: string;
+ web_url: string;
/**
* Format: uri
* @description API URL to access available alternate machine types for this codespace.
*/
- readonly machines_url: string;
+ machines_url: string;
/**
* Format: uri
* @description API URL to start this codespace.
*/
- readonly start_url: string;
+ start_url: string;
/**
* Format: uri
* @description API URL to stop this codespace.
*/
- readonly stop_url: string;
+ stop_url: string;
/**
* Format: uri
* @description API URL to publish this codespace to a new repository.
*/
- readonly publish_url?: string | null;
+ publish_url?: string | null;
/**
* Format: uri
* @description API URL for the Pull Request associated with this codespace, if any.
*/
- readonly pulls_url: string | null;
- readonly recent_folders: readonly string[];
- readonly runtime_constraints?: {
+ pulls_url: string | null;
+ recent_folders: string[];
+ runtime_constraints?: {
/** @description The privacy settings a user can select from when forwarding a port. */
- readonly allowed_port_privacy_settings?: readonly string[] | null;
+ allowed_port_privacy_settings?: string[] | null;
};
/** @description Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it. */
- readonly pending_operation?: boolean | null;
+ pending_operation?: boolean | null;
/** @description Text to show user when codespace is disabled by a pending operation */
- readonly pending_operation_disabled_reason?: string | null;
+ pending_operation_disabled_reason?: string | null;
/** @description Text to show user when codespace idle timeout minutes has been overriden by an organization policy */
- readonly idle_timeout_notice?: string | null;
+ idle_timeout_notice?: string | null;
/**
* @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
* @example 60
*/
- readonly retention_period_minutes?: number | null;
+ retention_period_minutes?: number | null;
/**
* Format: date-time
* @description When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
* @example 2011-01-26T20:01:12Z
*/
- readonly retention_expires_at?: string | null;
+ retention_expires_at?: string | null;
};
/**
* Email
* @description Email
*/
- readonly email: {
+ email: {
/**
* Format: email
* @example octocat@github.com
*/
- readonly email: string;
+ email: string;
/** @example true */
- readonly primary: boolean;
+ primary: boolean;
/** @example true */
- readonly verified: boolean;
+ verified: boolean;
/** @example public */
- readonly visibility: string | null;
+ visibility: string | null;
};
/**
* GPG Key
* @description A unique encryption key
*/
- readonly "gpg-key": {
+ "gpg-key": {
/**
* Format: int64
* @example 3
*/
- readonly id: number;
+ id: number;
/** @example Octocat's GPG Key */
- readonly name?: string | null;
- readonly primary_key_id: number | null;
+ name?: string | null;
+ primary_key_id: number | null;
/** @example 3262EFF25BA0D270 */
- readonly key_id: string;
+ key_id: string;
/** @example xsBNBFayYZ... */
- readonly public_key: string;
+ public_key: string;
/**
* @example [
* {
@@ -34625,9 +37321,9 @@ export type components = {
* }
* ]
*/
- readonly emails: readonly {
- readonly email?: string;
- readonly verified?: boolean;
+ emails: {
+ email?: string;
+ verified?: boolean;
}[];
/**
* @example [
@@ -34647,185 +37343,256 @@ export type components = {
* }
* ]
*/
- readonly subkeys: readonly {
+ subkeys: {
/** Format: int64 */
- readonly id?: number;
- readonly primary_key_id?: number;
- readonly key_id?: string;
- readonly public_key?: string;
- readonly emails?: readonly {
- readonly email?: string;
- readonly verified?: boolean;
+ id?: number;
+ primary_key_id?: number;
+ key_id?: string;
+ public_key?: string;
+ emails?: {
+ email?: string;
+ verified?: boolean;
}[];
- readonly subkeys?: readonly unknown[];
- readonly can_sign?: boolean;
- readonly can_encrypt_comms?: boolean;
- readonly can_encrypt_storage?: boolean;
- readonly can_certify?: boolean;
- readonly created_at?: string;
- readonly expires_at?: string | null;
- readonly raw_key?: string | null;
- readonly revoked?: boolean;
+ subkeys?: unknown[];
+ can_sign?: boolean;
+ can_encrypt_comms?: boolean;
+ can_encrypt_storage?: boolean;
+ can_certify?: boolean;
+ created_at?: string;
+ expires_at?: string | null;
+ raw_key?: string | null;
+ revoked?: boolean;
}[];
/** @example true */
- readonly can_sign: boolean;
- readonly can_encrypt_comms: boolean;
- readonly can_encrypt_storage: boolean;
+ can_sign: boolean;
+ can_encrypt_comms: boolean;
+ can_encrypt_storage: boolean;
/** @example true */
- readonly can_certify: boolean;
+ can_certify: boolean;
/**
* Format: date-time
* @example 2016-03-24T11:31:04-06:00
*/
- readonly created_at: string;
+ created_at: string;
/** Format: date-time */
- readonly expires_at: string | null;
+ expires_at: string | null;
/** @example true */
- readonly revoked: boolean;
- readonly raw_key: string | null;
+ revoked: boolean;
+ raw_key: string | null;
};
/**
* Key
* @description Key
*/
- readonly key: {
- readonly key: string;
+ key: {
+ key: string;
/** Format: int64 */
- readonly id: number;
- readonly url: string;
- readonly title: string;
+ id: number;
+ url: string;
+ title: string;
+ /** Format: date-time */
+ created_at: string;
+ verified: boolean;
+ read_only: boolean;
/** Format: date-time */
- readonly created_at: string;
- readonly verified: boolean;
- readonly read_only: boolean;
+ last_used?: string | null;
};
/** Marketplace Account */
- readonly "marketplace-account": {
+ "marketplace-account": {
/** Format: uri */
- readonly url: string;
- readonly id: number;
- readonly type: string;
- readonly node_id?: string;
- readonly login: string;
+ url: string;
+ id: number;
+ type: string;
+ node_id?: string;
+ login: string;
/** Format: email */
- readonly email?: string | null;
+ email?: string | null;
/** Format: email */
- readonly organization_billing_email?: string | null;
+ organization_billing_email?: string | null;
};
/**
* User Marketplace Purchase
* @description User Marketplace Purchase
*/
- readonly "user-marketplace-purchase": {
+ "user-marketplace-purchase": {
/** @example monthly */
- readonly billing_cycle: string;
+ billing_cycle: string;
/**
* Format: date-time
* @example 2017-11-11T00:00:00Z
*/
- readonly next_billing_date: string | null;
- readonly unit_count: number | null;
+ next_billing_date: string | null;
+ unit_count: number | null;
/** @example true */
- readonly on_free_trial: boolean;
+ on_free_trial: boolean;
/**
* Format: date-time
* @example 2017-11-11T00:00:00Z
*/
- readonly free_trial_ends_on: string | null;
+ free_trial_ends_on: string | null;
/**
* Format: date-time
* @example 2017-11-02T01:12:12Z
*/
- readonly updated_at: string | null;
- readonly account: components["schemas"]["marketplace-account"];
- readonly plan: components["schemas"]["marketplace-listing-plan"];
+ updated_at: string | null;
+ account: components["schemas"]["marketplace-account"];
+ plan: components["schemas"]["marketplace-listing-plan"];
};
/**
* Social account
* @description Social media account
*/
- readonly "social-account": {
+ "social-account": {
/** @example linkedin */
- readonly provider: string;
+ provider: string;
/** @example https://www.linkedin.com/company/github/ */
- readonly url: string;
+ url: string;
};
/**
* SSH Signing Key
* @description A public SSH key used to sign Git commits
*/
- readonly "ssh-signing-key": {
- readonly key: string;
- readonly id: number;
- readonly title: string;
+ "ssh-signing-key": {
+ key: string;
+ id: number;
+ title: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
};
/**
* Starred Repository
* @description Starred Repository
*/
- readonly "starred-repository": {
+ "starred-repository": {
/** Format: date-time */
- readonly starred_at: string;
- readonly repo: components["schemas"]["repository"];
- };
- /**
- * Sigstore Bundle v0.1
- * @description Sigstore Bundle v0.1
- */
- readonly "sigstore-bundle-0": {
- readonly mediaType?: string;
- readonly verificationMaterial?: {
- readonly x509CertificateChain?: {
- readonly certificates?: readonly {
- readonly rawBytes?: string;
- }[];
- };
- readonly tlogEntries?: readonly {
- readonly logIndex?: string;
- readonly logId?: {
- readonly keyId?: string;
- };
- readonly kindVersion?: {
- readonly kind?: string;
- readonly version?: string;
- };
- readonly integratedTime?: string;
- readonly inclusionPromise?: {
- readonly signedEntryTimestamp?: string;
- };
- readonly inclusionProof?: string | null;
- readonly canonicalizedBody?: string;
- }[];
- readonly timestampVerificationData?: string | null;
- };
- readonly dsseEnvelope?: {
- readonly payload?: string;
- readonly payloadType?: string;
- readonly signatures?: readonly {
- readonly sig?: string;
- readonly keyid?: string;
- }[];
- };
+ starred_at: string;
+ repo: components["schemas"]["repository"];
};
/**
* Hovercard
* @description Hovercard
*/
- readonly hovercard: {
- readonly contexts: readonly {
- readonly message: string;
- readonly octicon: string;
+ hovercard: {
+ contexts: {
+ message: string;
+ octicon: string;
}[];
};
/**
* Key Simple
* @description Key Simple
*/
- readonly "key-simple": {
- readonly id: number;
- readonly key: string;
+ "key-simple": {
+ id: number;
+ key: string;
+ /** Format: date-time */
+ created_at?: string;
+ /** Format: date-time */
+ last_used?: string | null;
+ };
+ "billing-premium-request-usage-report-user": {
+ timePeriod: {
+ /** @description The year for the usage report. */
+ year: number;
+ /** @description The month for the usage report. */
+ month?: number;
+ /** @description The day for the usage report. */
+ day?: number;
+ };
+ /** @description The unique identifier of the user. */
+ user: string;
+ /** @description The product for the usage report. */
+ product?: string;
+ /** @description The model for the usage report. */
+ model?: string;
+ usageItems: {
+ /** @description Product name. */
+ product: string;
+ /** @description SKU name. */
+ sku: string;
+ /** @description Model name. */
+ model: string;
+ /** @description Unit type of the usage line item. */
+ unitType: string;
+ /** @description Price per unit of the usage line item. */
+ pricePerUnit: number;
+ /** @description Gross quantity of the usage line item. */
+ grossQuantity: number;
+ /** @description Gross amount of the usage line item. */
+ grossAmount: number;
+ /** @description Discount quantity of the usage line item. */
+ discountQuantity: number;
+ /** @description Discount amount of the usage line item. */
+ discountAmount: number;
+ /** @description Net quantity of the usage line item. */
+ netQuantity: number;
+ /** @description Net amount of the usage line item. */
+ netAmount: number;
+ }[];
+ };
+ "billing-usage-report-user": {
+ usageItems?: {
+ /** @description Date of the usage line item. */
+ date: string;
+ /** @description Product name. */
+ product: string;
+ /** @description SKU name. */
+ sku: string;
+ /** @description Quantity of the usage line item. */
+ quantity: number;
+ /** @description Unit type of the usage line item. */
+ unitType: string;
+ /** @description Price per unit of the usage line item. */
+ pricePerUnit: number;
+ /** @description Gross amount of the usage line item. */
+ grossAmount: number;
+ /** @description Discount amount of the usage line item. */
+ discountAmount: number;
+ /** @description Net amount of the usage line item. */
+ netAmount: number;
+ /** @description Name of the repository. */
+ repositoryName?: string;
+ }[];
+ };
+ "billing-usage-summary-report-user": {
+ timePeriod: {
+ /** @description The year for the usage report. */
+ year: number;
+ /** @description The month for the usage report. */
+ month?: number;
+ /** @description The day for the usage report. */
+ day?: number;
+ };
+ /** @description The unique identifier of the user. */
+ user: string;
+ /** @description The name of the repository for the usage report. */
+ repository?: string;
+ /** @description The product for the usage report. */
+ product?: string;
+ /** @description The SKU for the usage report. */
+ sku?: string;
+ usageItems: {
+ /** @description Product name. */
+ product: string;
+ /** @description SKU name. */
+ sku: string;
+ /** @description Unit type of the usage line item. */
+ unitType: string;
+ /** @description Price per unit of the usage line item. */
+ pricePerUnit: number;
+ /** @description Gross quantity of the usage line item. */
+ grossQuantity: number;
+ /** @description Gross amount of the usage line item. */
+ grossAmount: number;
+ /** @description Discount quantity of the usage line item. */
+ discountQuantity: number;
+ /** @description Discount amount of the usage line item. */
+ discountAmount: number;
+ /** @description Net quantity of the usage line item. */
+ netQuantity: number;
+ /** @description Net amount of the usage line item. */
+ netAmount: number;
+ }[];
};
/**
* Enterprise
@@ -34833,48 +37600,48 @@ export type components = {
* on an enterprise account or an organization that's part of an enterprise account. For more information,
* see "[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts)."
*/
- readonly "enterprise-webhooks": {
+ "enterprise-webhooks": {
/** @description A short description of the enterprise. */
- readonly description?: string | null;
+ description?: string | null;
/**
* Format: uri
* @example https://github.com/enterprises/octo-business
*/
- readonly html_url: string;
+ html_url: string;
/**
* Format: uri
* @description The enterprise's website URL.
*/
- readonly website_url?: string | null;
+ website_url?: string | null;
/**
* @description Unique identifier of the enterprise
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the enterprise.
* @example Octo Business
*/
- readonly name: string;
+ name: string;
/**
* @description The slug url identifier for the enterprise.
* @example octo-business
*/
- readonly slug: string;
+ slug: string;
/**
* Format: date-time
* @example 2019-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ created_at: string | null;
/**
* Format: date-time
* @example 2019-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
/** Format: uri */
- readonly avatar_url: string;
+ avatar_url: string;
};
/**
* Simple Installation
@@ -34882,440 +37649,451 @@ export type components = {
* 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)."
*/
- readonly "simple-installation": {
+ "simple-installation": {
/**
* @description The ID of the installation.
* @example 1
*/
- readonly id: number;
+ id: number;
/**
* @description The global node ID of the installation.
* @example MDQ6VXNlcjU4MzIzMQ==
*/
- readonly node_id: string;
+ 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.
*/
- readonly "organization-simple-webhooks": {
+ "organization-simple-webhooks": {
/** @example github */
- readonly login: string;
+ login: string;
/** @example 1 */
- readonly id: number;
+ id: number;
/** @example MDEyOk9yZ2FuaXphdGlvbjE= */
- readonly node_id: string;
+ node_id: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github
*/
- readonly url: string;
+ url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/repos
*/
- readonly repos_url: string;
+ repos_url: string;
/**
* Format: uri
* @example https://api.github.com/orgs/github/events
*/
- readonly events_url: string;
+ events_url: string;
/** @example https://api.github.com/orgs/github/hooks */
- readonly hooks_url: string;
+ hooks_url: string;
/** @example https://api.github.com/orgs/github/issues */
- readonly issues_url: string;
+ issues_url: string;
/** @example https://api.github.com/orgs/github/members{/member} */
- readonly members_url: string;
+ members_url: string;
/** @example https://api.github.com/orgs/github/public_members{/member} */
- readonly public_members_url: string;
+ public_members_url: string;
/** @example https://github.com/images/error/octocat_happy.gif */
- readonly avatar_url: string;
+ avatar_url: string;
/** @example A great organization */
- readonly description: string | null;
+ 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.
*/
- readonly "repository-webhooks": {
+ "repository-webhooks": {
/**
* Format: int64
* @description Unique identifier of the repository
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the repository.
* @example Team Environment
*/
- readonly name: string;
+ name: string;
/** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- readonly owner: components["schemas"]["simple-user"];
+ 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
*/
- readonly private: boolean;
+ private: boolean;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World
*/
- readonly html_url: string;
+ html_url: string;
/** @example This your first repo! */
- readonly description: string | null;
- readonly fork: boolean;
+ description: string | null;
+ fork: boolean;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World
*/
- readonly url: string;
+ url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
+ archive_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
+ assignees_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
+ blobs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
+ branches_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
+ comments_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
+ commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
+ compare_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ contents_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- readonly contributors_url: string;
+ contributors_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- readonly deployments_url: string;
+ deployments_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- readonly downloads_url: string;
+ downloads_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/events
*/
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- readonly forks_url: string;
+ forks_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
+ git_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
+ issues_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
+ keys_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- readonly labels_url: string;
+ labels_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- readonly languages_url: string;
+ languages_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- readonly merges_url: string;
+ merges_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
+ milestones_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
+ notifications_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
+ pulls_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
+ releases_url: string;
/** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
+ ssh_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- readonly stargazers_url: string;
+ stargazers_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- readonly subscribers_url: string;
+ subscribers_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- readonly subscription_url: string;
+ subscription_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- readonly tags_url: string;
+ tags_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- readonly teams_url: string;
+ teams_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
+ trees_url: string;
/** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
+ clone_url: string;
/**
* Format: uri
* @example git:git.example.com/octocat/Hello-World
*/
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- readonly hooks_url: string;
+ hooks_url: string;
/**
* Format: uri
* @example https://svn.github.com/octocat/Hello-World
*/
- readonly svn_url: string;
+ svn_url: string;
/**
* Format: uri
* @example https://github.com
*/
- readonly homepage: string | null;
- readonly language: string | null;
+ homepage: string | null;
+ language: string | null;
/** @example 9 */
- readonly forks_count: number;
+ forks_count: number;
/** @example 80 */
- readonly stargazers_count: number;
+ stargazers_count: number;
/** @example 80 */
- readonly watchers_count: number;
+ watchers_count: number;
/**
* @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
- readonly size: number;
+ size: number;
/**
* @description The default branch of the repository.
* @example master
*/
- readonly default_branch: string;
+ default_branch: string;
/** @example 0 */
- readonly open_issues_count: number;
+ open_issues_count: number;
/**
* @description Whether this repository acts as a template that can be used to generate new repositories.
* @default false
* @example true
*/
- readonly is_template: boolean;
- readonly topics?: readonly string[];
+ is_template: boolean;
+ topics?: string[];
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/**
* @description Whether issues are enabled.
* @default true
* @example true
*/
- readonly has_issues: boolean;
+ has_issues: boolean;
/**
* @description Whether projects are enabled.
* @default true
* @example true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
* @example true
*/
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
+ has_wiki: boolean;
+ has_pages: boolean;
/**
* @description Whether downloads are enabled.
* @default true
* @example true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether discussions are enabled.
* @default false
* @example true
*/
- readonly has_discussions: boolean;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ * @example true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
* @default public
*/
- readonly visibility: string;
+ visibility: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string | null;
+ pushed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ created_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
* @example true
*/
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: readonly string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
+ 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:
*
@@ -35323,7 +38101,7 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -35332,7 +38110,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -35340,7 +38118,7 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -35349,42 +38127,42 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
} | null;
- readonly temp_clone_token?: string;
+ temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
* @example true
*/
- readonly allow_squash_merge: boolean;
+ allow_squash_merge: boolean;
/**
* @description Whether to allow Auto-merge to be used on pull requests.
* @default false
* @example false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
* @example false
*/
- readonly delete_branch_on_merge: boolean;
+ 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
*/
- readonly allow_update_branch: boolean;
+ allow_update_branch: boolean;
/**
* @deprecated
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/**
* @description The default value for a squash merge commit title:
*
@@ -35392,7 +38170,7 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -35401,7 +38179,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -35409,7 +38187,7 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -35418,2228 +38196,2192 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description Whether to allow merge commits for pull requests.
* @default true
* @example true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to require contributors to sign off on web-based commits
* @default false
*/
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
+ 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" */
- readonly starred_at?: string;
+ starred_at?: string;
/** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
+ anonymous_access_enabled?: boolean;
};
/**
* 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.
*/
- readonly webhooks_rule: {
- readonly admin_enforced: boolean;
+ webhooks_rule: {
+ admin_enforced: boolean;
/** @enum {string} */
- readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
+ allow_deletions_enforcement_level: "off" | "non_admins" | "everyone";
/** @enum {string} */
- readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
- readonly authorized_actor_names: readonly string[];
- readonly authorized_actors_only: boolean;
- readonly authorized_dismissal_actors_only: boolean;
- readonly create_protected?: boolean;
+ allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone";
+ authorized_actor_names: string[];
+ authorized_actors_only: boolean;
+ authorized_dismissal_actors_only: boolean;
+ create_protected?: boolean;
/** Format: date-time */
- readonly created_at: string;
- readonly dismiss_stale_reviews_on_push: boolean;
- readonly id: number;
- readonly ignore_approvals_from_contributors: boolean;
+ created_at: string;
+ dismiss_stale_reviews_on_push: boolean;
+ id: number;
+ ignore_approvals_from_contributors: boolean;
/** @enum {string} */
- readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone";
/**
* @description The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.
* @enum {string}
*/
- readonly lock_branch_enforcement_level: "off" | "non_admins" | "everyone";
+ lock_branch_enforcement_level: "off" | "non_admins" | "everyone";
/** @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks. */
- readonly lock_allows_fork_sync?: boolean;
+ lock_allows_fork_sync?: boolean;
/** @enum {string} */
- readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
- readonly name: string;
+ merge_queue_enforcement_level: "off" | "non_admins" | "everyone";
+ name: string;
/** @enum {string} */
- readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
- readonly repository_id: number;
- readonly require_code_owner_review: boolean;
+ pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone";
+ repository_id: number;
+ require_code_owner_review: boolean;
/** @description Whether the most recent push must be approved by someone other than the person who pushed it */
- readonly require_last_push_approval?: boolean;
- readonly required_approving_review_count: number;
+ require_last_push_approval?: boolean;
+ required_approving_review_count: number;
/** @enum {string} */
- readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone";
+ required_conversation_resolution_level: "off" | "non_admins" | "everyone";
/** @enum {string} */
- readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
- readonly required_status_checks: readonly string[];
+ required_deployments_enforcement_level: "off" | "non_admins" | "everyone";
+ required_status_checks: string[];
/** @enum {string} */
- readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
+ required_status_checks_enforcement_level: "off" | "non_admins" | "everyone";
/** @enum {string} */
- readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
- readonly strict_required_status_checks_policy: boolean;
+ signature_requirement_enforcement_level: "off" | "non_admins" | "everyone";
+ strict_required_status_checks_policy: boolean;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
};
/** @description A suite of checks performed on the code of a given code change */
- readonly "simple-check-suite": {
+ "simple-check-suite": {
/** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */
- readonly after?: string | null;
- readonly app?: components["schemas"]["integration"];
+ after?: string | null;
+ app?: components["schemas"]["integration"];
/** @example 146e867f55c26428e5f9fade55a9bbf5e95a7912 */
- readonly before?: string | null;
+ before?: string | null;
/**
* @example neutral
* @enum {string|null}
*/
- readonly conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null;
+ conclusion?: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "stale" | "startup_failure" | null;
/** Format: date-time */
- readonly created_at?: string;
+ created_at?: string;
/** @example master */
- readonly head_branch?: string | null;
+ head_branch?: string | null;
/**
* @description The SHA of the head commit that is being checked.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha?: string;
+ head_sha?: string;
/** @example 5 */
- readonly id?: number;
+ id?: number;
/** @example MDEwOkNoZWNrU3VpdGU1 */
- readonly node_id?: string;
- readonly pull_requests?: readonly components["schemas"]["pull-request-minimal"][];
- readonly repository?: components["schemas"]["minimal-repository"];
+ node_id?: string;
+ pull_requests?: components["schemas"]["pull-request-minimal"][];
+ repository?: components["schemas"]["minimal-repository"];
/**
* @example completed
* @enum {string}
*/
- readonly status?: "queued" | "in_progress" | "completed" | "pending" | "waiting";
+ status?: "queued" | "in_progress" | "completed" | "pending" | "waiting";
/** Format: date-time */
- readonly updated_at?: string;
+ updated_at?: string;
/** @example https://api.github.com/repos/github/hello-world/check-suites/5 */
- readonly url?: string;
+ url?: string;
};
/**
* CheckRun
* @description A check performed on the code of a given code change
*/
- readonly "check-run-with-simple-check-suite": {
- readonly app: components["schemas"]["nullable-integration"];
- readonly check_suite: components["schemas"]["simple-check-suite"];
+ "check-run-with-simple-check-suite": {
+ app: components["schemas"]["integration"];
+ check_suite: components["schemas"]["simple-check-suite"];
/**
* Format: date-time
* @example 2018-05-04T01:14:52Z
*/
- readonly completed_at: string | null;
+ completed_at: string | null;
/**
* @example neutral
* @enum {string|null}
*/
- readonly conclusion: "waiting" | "pending" | "startup_failure" | "stale" | "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null;
- readonly deployment?: components["schemas"]["deployment-simple"];
+ 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 */
- readonly details_url: string;
+ details_url: string;
/** @example 42 */
- readonly external_id: string;
+ external_id: string;
/**
* @description The SHA of the commit that is being checked.
* @example 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
*/
- readonly head_sha: string;
+ head_sha: string;
/** @example https://github.com/github/hello-world/runs/4 */
- readonly html_url: string;
+ html_url: string;
/**
* @description The id of the check.
* @example 21
*/
- readonly id: number;
+ id: number;
/**
* @description The name of the check.
* @example test-coverage
*/
- readonly name: string;
+ name: string;
/** @example MDg6Q2hlY2tSdW40 */
- readonly node_id: string;
- readonly output: {
- readonly annotations_count: number;
+ node_id: string;
+ output: {
+ annotations_count: number;
/** Format: uri */
- readonly annotations_url: string;
- readonly summary: string | null;
- readonly text: string | null;
- readonly title: string | null;
+ annotations_url: string;
+ summary: string | null;
+ text: string | null;
+ title: string | null;
};
- readonly pull_requests: readonly components["schemas"]["pull-request-minimal"][];
+ pull_requests: components["schemas"]["pull-request-minimal"][];
/**
* Format: date-time
* @example 2018-05-04T01:14:52Z
*/
- readonly started_at: string;
+ started_at: string;
/**
* @description The phase of the lifecycle that the check is currently in.
* @example queued
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "pending";
+ status: "queued" | "in_progress" | "completed" | "pending";
/** @example https://api.github.com/repos/github/hello-world/check-runs/4 */
- readonly url: string;
+ url: string;
};
/** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly webhooks_code_scanning_commit_oid: string;
+ webhooks_code_scanning_commit_oid: string;
/** @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. */
- readonly webhooks_code_scanning_ref: string;
+ webhooks_code_scanning_ref: string;
/** @description The pusher type for the event. Can be either `user` or a deploy key. */
- readonly webhooks_deploy_pusher_type: string;
+ webhooks_deploy_pusher_type: string;
/** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */
- readonly webhooks_ref_0: string;
+ webhooks_ref_0: string;
/** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */
- readonly webhooks_deploy_key: {
- readonly added_by?: string | null;
- readonly created_at: string;
- readonly id: number;
- readonly key: string;
- readonly last_used?: string | null;
- readonly read_only: boolean;
- readonly title: string;
+ webhooks_deploy_key: {
+ added_by?: string | null;
+ created_at: string;
+ id: number;
+ key: string;
+ last_used?: string | null;
+ read_only: boolean;
+ title: string;
/** Format: uri */
- readonly url: string;
- readonly verified: boolean;
- readonly enabled?: boolean;
+ url: string;
+ verified: boolean;
+ enabled?: boolean;
};
/** Workflow */
- readonly webhooks_workflow: {
+ webhooks_workflow: {
/** Format: uri */
- readonly badge_url: string;
+ badge_url: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly state: string;
+ html_url: string;
+ id: number;
+ name: string;
+ node_id: string;
+ path: string;
+ state: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly webhooks_approver: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
- };
- readonly webhooks_reviewers: readonly {
+ /**
+ * Deployment
+ * @description A request for a specific ref(branch,sha,tag) to be deployed
+ */
+ "nullable-deployment": {
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example/deployments/1
+ */
+ url: string;
+ /**
+ * Format: int64
+ * @description Unique identifier of the deployment
+ * @example 42
+ */
+ id: number;
+ /** @example MDEwOkRlcGxveW1lbnQx */
+ node_id: string;
+ /** @example a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d */
+ sha: string;
+ /**
+ * @description The ref to deploy. This can be a branch, tag, or sha.
+ * @example topic-branch
+ */
+ ref: string;
+ /**
+ * @description Parameter to specify a task to execute
+ * @example deploy
+ */
+ task: string;
+ payload: {
+ [key: string]: unknown;
+ } | string;
+ /** @example staging */
+ original_environment?: string;
+ /**
+ * @description Name for the target deployment environment.
+ * @example production
+ */
+ environment: string;
+ /** @example Deploy request from hubot */
+ description: string | null;
+ creator: components["schemas"]["nullable-simple-user"];
+ /**
+ * Format: date-time
+ * @example 2012-07-20T01:19:13Z
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @example 2012-07-20T01:19:13Z
+ */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example/deployments/1/statuses
+ */
+ statuses_url: string;
+ /**
+ * Format: uri
+ * @example https://api.github.com/repos/octocat/example
+ */
+ repository_url: string;
+ /**
+ * @description Specifies if the given environment is will no longer exist at some point in the future. Default: false.
+ * @example true
+ */
+ transient_environment?: boolean;
+ /**
+ * @description Specifies if the given environment is one that end-users directly interact with. Default: false.
+ * @example true
+ */
+ production_environment?: boolean;
+ performed_via_github_app?: components["schemas"]["nullable-integration"];
+ } | null;
+ webhooks_approver: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ webhooks_reviewers: {
/** User */
- readonly reviewer?: {
+ reviewer?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** @enum {string} */
- readonly type?: "User";
+ type?: "User";
}[];
- readonly webhooks_workflow_job_run: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: unknown;
- readonly status: string;
- readonly updated_at: string;
+ webhooks_workflow_job_run: {
+ conclusion: unknown;
+ created_at: string;
+ environment: string;
+ html_url: string;
+ id: number;
+ name: unknown;
+ status: string;
+ updated_at: string;
};
/** User */
- readonly webhooks_user: {
+ webhooks_user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly webhooks_answer: {
+ webhooks_answer: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ body: string;
+ child_comment_count: number;
/** Format: date-time */
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: unknown;
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: unknown;
/** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- /** Format: date-time */
- readonly updated_at: string;
- /** User */
- readonly user: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- /** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
- } | null;
- };
- /**
- * Discussion
- * @description A Discussion in a repository.
- */
- readonly discussion: {
- readonly active_lock_reason: string | null;
- readonly answer_chosen_at: string | null;
- /** User */
- readonly answer_chosen_by: {
- /** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
- /** Format: uri-template */
- readonly events_url?: string;
- /** Format: uri */
- readonly followers_url?: string;
- /** Format: uri-template */
- readonly following_url?: string;
- /** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- /** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
- /** Format: uri */
- readonly organizations_url?: string;
- /** Format: uri */
- readonly received_events_url?: string;
- /** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- /** Format: uri-template */
- readonly starred_url?: string;
- /** Format: uri */
- readonly subscriptions_url?: string;
- /** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
- /** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
- } | null;
- readonly answer_html_url: string | null;
- /**
- * AuthorAssociation
- * @description How the author is associated with the repository.
- * @enum {string}
- */
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly category: {
- /** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
- };
- readonly comments: number;
- /** Format: date-time */
- readonly created_at: string;
- readonly html_url: string;
- readonly id: number;
- readonly locked: boolean;
- readonly node_id: string;
- readonly number: number;
- /** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly 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}
- */
- readonly state: "open" | "closed" | "locked" | "converting" | "transferring";
- /**
- * @description The reason for the current state
- * @example resolved
- * @enum {string|null}
- */
- readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened" | null;
- readonly timeline_url?: string;
- readonly title: string;
+ 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;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly labels?: readonly components["schemas"]["label"][];
};
- readonly webhooks_comment: {
+ webhooks_comment: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
- readonly body: string;
- readonly child_comment_count: number;
- readonly created_at: string;
- readonly discussion_id: number;
- readonly html_url: string;
- readonly id: number;
- readonly node_id: string;
- readonly parent_id: number | null;
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ body: string;
+ child_comment_count: number;
+ created_at: string;
+ discussion_id: number;
+ html_url: string;
+ id: number;
+ node_id: string;
+ parent_id: number | null;
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly repository_url: string;
- readonly updated_at: string;
+ 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;
+ updated_at: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Label */
- readonly webhooks_label: {
+ webhooks_label: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
};
/** @description An array of repository objects that the installation can access. */
- readonly webhooks_repositories: readonly {
- readonly full_name: string;
+ webhooks_repositories: {
+ full_name: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
}[];
/** @description An array of repository objects, which were added to the installation. */
- readonly webhooks_repositories_added: readonly {
- readonly full_name: string;
+ webhooks_repositories_added: {
+ full_name: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
}[];
/**
* @description Describe whether all repositories have been selected or there's a selection involved
* @enum {string}
*/
- readonly webhooks_repository_selection: "all" | "selected";
+ webhooks_repository_selection: "all" | "selected";
/**
* issue comment
* @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
*/
- readonly webhooks_issue_comment: {
+ webhooks_issue_comment: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue comment */
- readonly body: string;
+ body: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the issue comment
*/
- readonly id: number;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["integration"];
+ issue_url: string;
+ node_id: string;
+ performed_via_github_app: components["schemas"]["integration"];
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue comment
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
+ pin?: components["schemas"]["nullable-pinned-issue-comment"];
};
/** @description The changes to the comment. */
- readonly webhooks_changes: {
- readonly body?: {
+ webhooks_changes: {
+ body?: {
/** @description The previous version of the body. */
- readonly from: string;
+ from: string;
};
};
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly webhooks_issue: {
+ webhooks_issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly webhooks_milestone: {
+ webhooks_milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly webhooks_issue_2: {
+ webhooks_issue_2: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** User */
- readonly webhooks_user_mannequin: {
+ webhooks_user_mannequin: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Marketplace Purchase */
- readonly webhooks_marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: readonly (string | null)[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
+ webhooks_marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: (string | null)[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
};
- readonly unit_count: number;
+ unit_count: number;
};
/** Marketplace Purchase */
- readonly webhooks_previous_marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: readonly string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
+ webhooks_previous_marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
};
- readonly unit_count: number;
+ unit_count: number;
};
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly webhooks_team: {
- readonly deleted?: boolean;
+ webhooks_team: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/**
* @description Whether team members will receive notifications when their team is @mentioned
* @enum {string}
*/
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ notification_setting: "notifications_enabled" | "notifications_disabled";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
+ /**
+ * @description The ownership type of the team
+ * @enum {string}
+ */
+ type: "enterprise" | "organization";
+ /**
+ * @description Unique identifier of the organization to which this team belongs
+ * @example 37
+ */
+ organization_id?: number;
+ /**
+ * @description Unique identifier of the enterprise to which this team belongs
+ * @example 42
+ */
+ enterprise_id?: number;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** @enum {string} */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
+ /**
+ * @description The ownership type of the team
+ * @enum {string}
+ */
+ type?: "enterprise" | "organization";
+ /**
+ * @description Unique identifier of the organization to which this team belongs
+ * @example 37
+ */
+ organization_id?: number;
+ /**
+ * @description Unique identifier of the enterprise to which this team belongs
+ * @example 42
+ */
+ enterprise_id?: number;
};
/**
* Merge Group
* @description A group of pull requests that the merge queue has grouped together to be merged.
*/
- readonly "merge-group": {
+ "merge-group": {
/** @description The SHA of the merge group. */
- readonly head_sha: string;
+ head_sha: string;
/** @description The full ref of the merge group. */
- readonly head_ref: string;
+ head_ref: string;
/** @description The SHA of the merge group's parent commit. */
- readonly base_sha: string;
+ base_sha: string;
/** @description The full ref of the branch the merge group will be merged into. */
- readonly base_ref: string;
- readonly head_commit: components["schemas"]["simple-commit"];
+ 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.
*/
- readonly "nullable-repository-webhooks": {
+ "nullable-repository-webhooks": {
/**
* Format: int64
* @description Unique identifier of the repository
* @example 42
*/
- readonly id: number;
+ id: number;
/** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */
- readonly node_id: string;
+ node_id: string;
/**
* @description The name of the repository.
* @example Team Environment
*/
- readonly name: string;
+ name: string;
/** @example octocat/Hello-World */
- readonly full_name: string;
- readonly license: components["schemas"]["nullable-license-simple"];
- readonly organization?: components["schemas"]["nullable-simple-user"];
- readonly forks: number;
- readonly permissions?: {
- readonly admin: boolean;
- readonly pull: boolean;
- readonly triage?: boolean;
- readonly push: boolean;
- readonly maintain?: boolean;
- };
- readonly owner: components["schemas"]["simple-user"];
+ 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
*/
- readonly private: boolean;
+ private: boolean;
/**
* Format: uri
* @example https://github.com/octocat/Hello-World
*/
- readonly html_url: string;
+ html_url: string;
/** @example This your first repo! */
- readonly description: string | null;
- readonly fork: boolean;
+ description: string | null;
+ fork: boolean;
/**
* Format: uri
* @example https://api.github.com/repos/octocat/Hello-World
*/
- readonly url: string;
+ url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */
- readonly archive_url: string;
+ archive_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */
- readonly assignees_url: string;
+ assignees_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */
- readonly blobs_url: string;
+ blobs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */
- readonly branches_url: string;
+ branches_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */
- readonly comments_url: string;
+ comments_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */
- readonly commits_url: string;
+ commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */
- readonly compare_url: string;
+ compare_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */
- readonly contents_url: string;
+ contents_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/contributors
*/
- readonly contributors_url: string;
+ contributors_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/deployments
*/
- readonly deployments_url: string;
+ deployments_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/downloads
*/
- readonly downloads_url: string;
+ downloads_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/events
*/
- readonly events_url: string;
+ events_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/forks
*/
- readonly forks_url: string;
+ forks_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** @example git:github.com/octocat/Hello-World.git */
- readonly git_url: string;
+ git_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */
- readonly issues_url: string;
+ issues_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */
- readonly keys_url: string;
+ keys_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */
- readonly labels_url: string;
+ labels_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/languages
*/
- readonly languages_url: string;
+ languages_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/merges
*/
- readonly merges_url: string;
+ merges_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */
- readonly milestones_url: string;
+ milestones_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */
- readonly notifications_url: string;
+ notifications_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */
- readonly pulls_url: string;
+ pulls_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */
- readonly releases_url: string;
+ releases_url: string;
/** @example git@github.com:octocat/Hello-World.git */
- readonly ssh_url: string;
+ ssh_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/stargazers
*/
- readonly stargazers_url: string;
+ stargazers_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */
- readonly statuses_url: string;
+ statuses_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscribers
*/
- readonly subscribers_url: string;
+ subscribers_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/subscription
*/
- readonly subscription_url: string;
+ subscription_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/tags
*/
- readonly tags_url: string;
+ tags_url: string;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/teams
*/
- readonly teams_url: string;
+ teams_url: string;
/** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */
- readonly trees_url: string;
+ trees_url: string;
/** @example https://github.com/octocat/Hello-World.git */
- readonly clone_url: string;
+ clone_url: string;
/**
* Format: uri
* @example git:git.example.com/octocat/Hello-World
*/
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/**
* Format: uri
* @example http://api.github.com/repos/octocat/Hello-World/hooks
*/
- readonly hooks_url: string;
+ hooks_url: string;
/**
* Format: uri
* @example https://svn.github.com/octocat/Hello-World
*/
- readonly svn_url: string;
+ svn_url: string;
/**
* Format: uri
* @example https://github.com
*/
- readonly homepage: string | null;
- readonly language: string | null;
+ homepage: string | null;
+ language: string | null;
/** @example 9 */
- readonly forks_count: number;
+ forks_count: number;
/** @example 80 */
- readonly stargazers_count: number;
+ stargazers_count: number;
/** @example 80 */
- readonly watchers_count: number;
+ watchers_count: number;
/**
* @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
* @example 108
*/
- readonly size: number;
+ size: number;
/**
* @description The default branch of the repository.
* @example master
*/
- readonly default_branch: string;
+ default_branch: string;
/** @example 0 */
- readonly open_issues_count: number;
+ open_issues_count: number;
/**
* @description Whether this repository acts as a template that can be used to generate new repositories.
* @default false
* @example true
*/
- readonly is_template: boolean;
- readonly topics?: readonly string[];
+ is_template: boolean;
+ topics?: string[];
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/**
* @description Whether issues are enabled.
* @default true
* @example true
*/
- readonly has_issues: boolean;
+ has_issues: boolean;
/**
* @description Whether projects are enabled.
* @default true
* @example true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
* @example true
*/
- readonly has_wiki: boolean;
- readonly has_pages: boolean;
+ has_wiki: boolean;
+ has_pages: boolean;
/**
* @description Whether downloads are enabled.
* @default true
* @example true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether discussions are enabled.
* @default false
* @example true
*/
- readonly has_discussions: boolean;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ * @example true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** @description Returns whether or not this repository disabled. */
- readonly disabled: boolean;
+ disabled: boolean;
/**
* @description The repository visibility: public, private, or internal.
* @default public
*/
- readonly visibility: string;
+ visibility: string;
/**
* Format: date-time
* @example 2011-01-26T19:06:43Z
*/
- readonly pushed_at: string | null;
+ pushed_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:01:12Z
*/
- readonly created_at: string | null;
+ created_at: string | null;
/**
* Format: date-time
* @example 2011-01-26T19:14:43Z
*/
- readonly updated_at: string | null;
+ updated_at: string | null;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
* @example true
*/
- readonly allow_rebase_merge: boolean;
- readonly template_repository?: {
- readonly id?: number;
- readonly node_id?: string;
- readonly name?: string;
- readonly full_name?: string;
- readonly owner?: {
- readonly login?: string;
- readonly id?: number;
- readonly node_id?: string;
- readonly avatar_url?: string;
- readonly gravatar_id?: string;
- readonly url?: string;
- readonly html_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly organizations_url?: string;
- readonly repos_url?: string;
- readonly events_url?: string;
- readonly received_events_url?: string;
- readonly type?: string;
- readonly site_admin?: boolean;
- };
- readonly private?: boolean;
- readonly html_url?: string;
- readonly description?: string;
- readonly fork?: boolean;
- readonly url?: string;
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly forks_url?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly notifications_url?: string;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly ssh_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly clone_url?: string;
- readonly mirror_url?: string;
- readonly hooks_url?: string;
- readonly svn_url?: string;
- readonly homepage?: string;
- readonly language?: string;
- readonly forks_count?: number;
- readonly stargazers_count?: number;
- readonly watchers_count?: number;
- readonly size?: number;
- readonly default_branch?: string;
- readonly open_issues_count?: number;
- readonly is_template?: boolean;
- readonly topics?: readonly string[];
- readonly has_issues?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly has_pages?: boolean;
- readonly has_downloads?: boolean;
- readonly archived?: boolean;
- readonly disabled?: boolean;
- readonly visibility?: string;
- readonly pushed_at?: string;
- readonly created_at?: string;
- readonly updated_at?: string;
- readonly permissions?: {
- readonly admin?: boolean;
- readonly maintain?: boolean;
- readonly push?: boolean;
- readonly triage?: boolean;
- readonly pull?: boolean;
- };
- readonly allow_rebase_merge?: boolean;
- readonly temp_clone_token?: string;
- readonly allow_squash_merge?: boolean;
- readonly allow_auto_merge?: boolean;
- readonly delete_branch_on_merge?: boolean;
- readonly allow_update_branch?: boolean;
- readonly use_squash_pr_title_as_default?: boolean;
+ 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:
*
@@ -37647,7 +40389,7 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -37656,7 +40398,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -37664,7 +40406,7 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -37673,42 +40415,42 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
- readonly allow_merge_commit?: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ allow_merge_commit?: boolean;
+ subscribers_count?: number;
+ network_count?: number;
} | null;
- readonly temp_clone_token?: string;
+ temp_clone_token?: string;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
* @example true
*/
- readonly allow_squash_merge: boolean;
+ allow_squash_merge: boolean;
/**
* @description Whether to allow Auto-merge to be used on pull requests.
* @default false
* @example false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
* @example false
*/
- readonly delete_branch_on_merge: boolean;
+ 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
*/
- readonly allow_update_branch: boolean;
+ allow_update_branch: boolean;
/**
* @deprecated
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/**
* @description The default value for a squash merge commit title:
*
@@ -37716,7 +40458,7 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -37725,7 +40467,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -37733,7 +40475,7 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -37742,522 +40484,523 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description Whether to allow merge commits for pull requests.
* @default true
* @example true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/** @description Whether to allow forking this repo */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to require contributors to sign off on web-based commits
* @default false
*/
- readonly web_commit_signoff_required: boolean;
- readonly subscribers_count?: number;
- readonly network_count?: number;
- readonly open_issues: number;
- readonly watchers: number;
- readonly master_branch?: string;
+ 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" */
- readonly starred_at?: string;
+ starred_at?: string;
/** @description Whether anonymous git access is enabled for this repository */
- readonly anonymous_access_enabled?: boolean;
+ anonymous_access_enabled?: boolean;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly webhooks_milestone_3: {
+ webhooks_milestone_3: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/**
* Membership
* @description The membership between the user and the organization. Not present when the action is `member_invited`.
*/
- readonly webhooks_membership: {
+ webhooks_membership: {
/** Format: uri */
- readonly organization_url: string;
- readonly role: string;
- readonly state: string;
+ organization_url: string;
+ role: string;
+ /**
+ * @description Whether the user has direct membership in the organization.
+ * @example true
+ */
+ direct_membership?: boolean;
+ /**
+ * @description The slugs of the enterprise teams providing the user with indirect membership in the organization.
+ * A limit of 100 enterprise team slugs is returned.
+ * @example [
+ * "ent:team-one",
+ * "ent:team-two"
+ * ]
+ */
+ enterprise_teams_providing_indirect_membership?: string[];
+ state: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/**
* Personal Access Token Request
* @description Details of a Personal Access Token Request.
*/
- readonly "personal-access-token-request": {
+ "personal-access-token-request": {
/** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */
- readonly id: number;
- readonly owner: components["schemas"]["simple-user"];
+ id: number;
+ owner: components["schemas"]["simple-user"];
/** @description New requested permissions, categorized by type of permission. */
- readonly permissions_added: {
- readonly organization?: {
- readonly [key: string]: string;
+ permissions_added: {
+ organization?: {
+ [key: string]: string;
};
- readonly repository?: {
- readonly [key: string]: string;
+ repository?: {
+ [key: string]: string;
};
- readonly other?: {
- readonly [key: string]: string;
+ other?: {
+ [key: string]: string;
};
};
/** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */
- readonly permissions_upgraded: {
- readonly organization?: {
- readonly [key: string]: string;
+ permissions_upgraded: {
+ organization?: {
+ [key: string]: string;
};
- readonly repository?: {
- readonly [key: string]: string;
+ repository?: {
+ [key: string]: string;
};
- readonly other?: {
- readonly [key: string]: string;
+ other?: {
+ [key: string]: string;
};
};
/** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */
- readonly permissions_result: {
- readonly organization?: {
- readonly [key: string]: string;
+ permissions_result: {
+ organization?: {
+ [key: string]: string;
};
- readonly repository?: {
- readonly [key: string]: string;
+ repository?: {
+ [key: string]: string;
};
- readonly other?: {
- readonly [key: string]: string;
+ other?: {
+ [key: string]: string;
};
};
/**
* @description Type of repository selection requested.
* @enum {string}
*/
- readonly repository_selection: "none" | "all" | "subset";
+ repository_selection: "none" | "all" | "subset";
/** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repository_count: number | null;
+ repository_count: number | null;
/** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */
- readonly repositories: readonly {
- readonly full_name: string;
+ repositories: {
+ full_name: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
}[] | null;
/** @description Date and time when the request for access was created. */
- readonly created_at: string;
+ created_at: string;
/** @description Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. */
- readonly token_id: number;
+ token_id: number;
/** @description The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. */
- readonly token_name: string;
+ token_name: string;
/** @description Whether the associated fine-grained personal access token has expired. */
- readonly token_expired: boolean;
+ token_expired: boolean;
/** @description Date and time when the associated fine-grained personal access token expires. */
- readonly token_expires_at: string | null;
+ token_expires_at: string | null;
/** @description Date and time when the associated fine-grained personal access token was last used for authentication. */
- readonly token_last_used_at: string | null;
+ token_last_used_at: string | null;
};
/** Project Card */
- readonly webhooks_project_card: {
- readonly after_id?: number | null;
+ webhooks_project_card: {
+ after_id?: number | null;
/** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
+ archived: boolean;
+ column_id: number;
/** Format: uri */
- readonly column_url: string;
+ column_url: string;
/** Format: uri */
- readonly content_url?: string;
+ content_url?: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
+ id: number;
+ node_id: string;
+ note: string | null;
/** Format: uri */
- readonly project_url: string;
+ project_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Project */
- readonly webhooks_project: {
+ webhooks_project: {
/** @description Body of the project */
- readonly body: string | null;
+ body: string | null;
/** Format: uri */
- readonly columns_url: string;
+ columns_url: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** @description Name of the project */
- readonly name: string;
- readonly node_id: string;
- readonly number: number;
+ name: string;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly owner_url: string;
+ owner_url: string;
/**
* @description State of the project; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Project Column */
- readonly webhooks_project_column: {
- readonly after_id?: number | null;
+ webhooks_project_column: {
+ after_id?: number | null;
/** Format: uri */
- readonly cards_url: string;
+ cards_url: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The unique identifier of the project column */
- readonly id: number;
+ id: number;
/** @description Name of the project column */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri */
- readonly project_url: string;
+ project_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- /**
- * Projects v2 Project
- * @description A projects v2 project
- */
- readonly "projects-v2": {
- readonly id: number;
- readonly node_id: string;
- readonly owner: components["schemas"]["simple-user"];
- readonly creator: components["schemas"]["simple-user"];
- readonly title: string;
- readonly description: string | null;
- readonly public: boolean;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly closed_at: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly created_at: string;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly updated_at: string;
- readonly number: number;
- readonly short_description: string | null;
- /**
- * Format: date-time
- * @example 2022-04-28T12:00:00Z
- */
- readonly deleted_at: string | null;
- readonly deleted_by: components["schemas"]["nullable-simple-user"];
- };
- readonly webhooks_project_changes: {
- readonly archived_at?: {
+ webhooks_project_changes: {
+ archived_at?: {
/** Format: date-time */
- readonly from?: string | null;
+ from?: string | null;
/** Format: date-time */
- readonly to?: string | null;
+ to?: string | null;
};
};
- /**
- * Projects v2 Item Content Type
- * @description The type of content tracked in a project item
- * @enum {string}
- */
- readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue";
/**
* Projects v2 Item
* @description An item belonging to a project
*/
- readonly "projects-v2-item": {
- readonly id: number;
- readonly node_id?: string;
- readonly project_node_id?: string;
- readonly content_node_id: string;
- readonly content_type: components["schemas"]["projects-v2-item-content-type"];
- readonly creator?: components["schemas"]["simple-user"];
+ "projects-v2-item": {
+ /** @description The unique identifier of the project item. */
+ id: number;
+ /** @description The node ID of the project item. */
+ node_id?: string;
+ /** @description The node ID of the project that contains this item. */
+ project_node_id?: string;
+ /** @description The node ID of the content represented by this item. */
+ content_node_id: string;
+ content_type: components["schemas"]["projects-v2-item-content-type"];
+ creator?: components["schemas"]["simple-user"];
/**
* Format: date-time
+ * @description The time when the item was created.
* @example 2022-04-28T12:00:00Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
+ * @description The time when the item was last updated.
* @example 2022-04-28T12:00:00Z
*/
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: date-time
+ * @description The time when the item was archived.
* @example 2022-04-28T12:00:00Z
*/
- readonly archived_at: string | null;
+ archived_at: string | null;
};
/**
* Projects v2 Single Select Option
* @description An option for a single select field
*/
- readonly "projects-v2-single-select-option": {
- readonly id: string;
- readonly name: string;
- readonly color?: string | null;
- readonly description?: string | null;
+ "projects-v2-single-select-option": {
+ /** @description The unique identifier of the option. */
+ id: string;
+ /** @description The display name of the option. */
+ name: string;
+ /** @description The color associated with the option. */
+ color?: string | null;
+ /** @description A short description of the option. */
+ description?: string | null;
};
/**
* Projects v2 Iteration Setting
* @description An iteration setting for an iteration field
*/
- readonly "projects-v2-iteration-setting": {
- readonly id: string;
- readonly title: string;
- readonly duration?: number | null;
- readonly start_date?: string | null;
+ "projects-v2-iteration-setting": {
+ /** @description The unique identifier of the iteration setting. */
+ id: string;
+ /** @description The iteration title. */
+ title: string;
+ /** @description The iteration title, rendered as HTML. */
+ title_html?: string;
+ /** @description The duration of the iteration in days. */
+ duration?: number | null;
+ /** @description The start date of the iteration. */
+ start_date?: string | null;
+ /** @description Whether the iteration has been completed. */
+ completed?: boolean;
};
/**
* Projects v2 Status Update
* @description An status update belonging to a project
*/
- readonly "projects-v2-status-update": {
- readonly id: number;
- readonly node_id: string;
- readonly project_node_id?: string;
- readonly creator?: components["schemas"]["simple-user"];
+ "projects-v2-status-update": {
+ /** @description The unique identifier of the status update. */
+ id: number;
+ /** @description The node ID of the status update. */
+ node_id: string;
+ /** @description The node ID of the project that this status update belongs to. */
+ project_node_id?: string;
+ creator?: components["schemas"]["simple-user"];
/**
* Format: date-time
+ * @description The time when the status update was created.
* @example 2022-04-28T12:00:00Z
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
+ * @description The time when the status update was last updated.
* @example 2022-04-28T12:00:00Z
*/
- readonly updated_at: string;
- /** @enum {string|null} */
- readonly status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
+ updated_at: string;
+ /**
+ * @description The current status.
+ * @enum {string|null}
+ */
+ status?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
/**
* Format: date
+ * @description The start date of the period covered by the update.
* @example 2022-04-28
*/
- readonly start_date?: string;
+ start_date?: string;
/**
* Format: date
+ * @description The target date associated with the update.
* @example 2022-04-28
*/
- readonly target_date?: string;
+ target_date?: string;
/**
* @description Body of the status update
* @example The project is off to a great start!
*/
- readonly body?: string | null;
+ body?: string | null;
};
/** @description The pull request number. */
- readonly webhooks_number: number;
- readonly "pull-request-webhook": components["schemas"]["pull-request"] & {
+ webhooks_number: number;
+ "pull-request-webhook": components["schemas"]["pull-request"] & {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow updating the pull request's branch. */
- readonly allow_update_branch?: boolean;
+ allow_update_branch?: boolean;
/**
* @description Whether to delete head branches when pull requests are merged.
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/**
* @description The default value for a merge commit message.
* - `PR_TITLE` - default to the pull request's title.
@@ -38265,14 +41008,14 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "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}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a squash merge commit message:
* - `PR_BODY` - default to the pull request's body.
@@ -38280,349 +41023,359 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.**
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
};
/** Pull Request */
- readonly webhooks_pull_request_5: {
- readonly _links: {
+ webhooks_pull_request_5: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -38631,7 +41384,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -38639,76 +41392,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -38717,7 +41470,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -38725,250 +41478,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -38977,7 +41740,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -38985,76 +41748,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -39063,7 +41826,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -39071,444 +41834,444 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/**
* Pull Request Review Comment
* @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
*/
- readonly webhooks_review_comment: {
- readonly _links: {
+ webhooks_review_comment: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -39516,138 +42279,138 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the comment. */
- readonly body: string;
+ body: string;
/** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
+ diff_hunk: string;
/**
* Format: uri
* @description HTML URL for the pull request review comment.
*/
- readonly html_url: string;
+ html_url: string;
/** @description The ID of the pull request review comment. */
- readonly id: number;
+ id: number;
/** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
+ in_reply_to_id?: number;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
+ line: number | null;
/** @description The node ID of the pull request review comment. */
- readonly node_id: string;
+ node_id: string;
/** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
+ original_commit_id: string;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number;
+ original_line: number;
/** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
+ original_position: number;
/** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
+ original_start_line: number | null;
/** @description The relative path of the file to which the comment applies. */
- readonly path: string;
+ path: string;
/** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
+ position: number | null;
/** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: uri
* @description URL for the pull request that the review comment belongs to.
*/
- readonly pull_request_url: string;
+ pull_request_url: string;
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/**
* @description The side of the first line of the range for a multi-line comment.
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
+ start_line: number | null;
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly subject_type?: "line" | "file";
+ subject_type?: "line" | "file";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the pull request review comment
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** @description The review that was affected. */
- readonly webhooks_review: {
- readonly _links: {
+ webhooks_review: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -39655,653 +42418,666 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the review. */
- readonly body: string | null;
+ body: string | null;
/** @description A commit SHA for the review. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the review */
- readonly id: number;
- readonly node_id: string;
+ id: number;
+ node_id: string;
/** Format: uri */
- readonly pull_request_url: string;
- readonly state: string;
+ pull_request_url: string;
+ state: string;
+ /** Format: date-time */
+ submitted_at: string | null;
/** Format: date-time */
- readonly submitted_at: string | null;
+ updated_at?: string | null;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly webhooks_nullable_string: string | null;
+ webhooks_nullable_string: string | null;
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
*/
- readonly webhooks_release: {
- readonly assets: readonly {
+ webhooks_release: {
+ assets: {
/** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
+ browser_download_url: string;
+ content_type: string;
/** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
/** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
+ name: string;
+ node_id: string;
+ size: number;
+ digest: string | null;
/**
* @description State of the release asset.
* @enum {string}
*/
- readonly state: "uploaded";
+ state: "uploaded";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** User */
- readonly uploader?: {
+ uploader?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
/** Format: uri */
- readonly assets_url: string;
+ assets_url: string;
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly created_at: string | null;
+ created_at: string | null;
+ /** Format: date-time */
+ updated_at: string | null;
/** Format: uri */
- readonly discussion_url?: string;
+ discussion_url?: string;
/** @description Whether the release is a draft or published */
- readonly draft: boolean;
+ draft: boolean;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
+ html_url: string;
+ id: number;
+ /** @description Whether or not the release is immutable. */
+ immutable: boolean;
+ name: string | null;
+ node_id: string;
/** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
+ prerelease: boolean;
/** Format: date-time */
- readonly published_at: string | null;
+ published_at: string | null;
/** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** @description The name of the tag. */
- readonly tag_name: string;
+ tag_name: string;
/** Format: uri */
- readonly tarball_url: string | null;
+ tarball_url: string | null;
/** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
+ target_commitish: string;
/** Format: uri-template */
- readonly upload_url: string;
+ upload_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly zipball_url: string | null;
+ zipball_url: string | null;
};
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
*/
- readonly webhooks_release_1: {
- readonly assets: readonly ({
+ webhooks_release_1: {
+ assets: ({
/** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
+ browser_download_url: string;
+ content_type: string;
/** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
/** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
+ name: string;
+ node_id: string;
+ size: number;
+ digest: string | null;
/**
* @description State of the release asset.
* @enum {string}
*/
- readonly state: "uploaded";
+ state: "uploaded";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** User */
- readonly uploader?: {
+ uploader?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri */
- readonly assets_url: string;
+ assets_url: string;
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly created_at: string | null;
+ created_at: string | null;
/** Format: uri */
- readonly discussion_url?: string;
+ discussion_url?: string;
/** @description Whether the release is a draft or published */
- readonly draft: boolean;
+ draft: boolean;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
+ html_url: string;
+ id: number;
+ /** @description Whether or not the release is immutable. */
+ immutable: boolean;
+ name: string | null;
+ node_id: string;
/** @description Whether the release is identified as a prerelease or a full release. */
- readonly prerelease: boolean;
+ prerelease: boolean;
/** Format: date-time */
- readonly published_at: string | null;
+ published_at: string | null;
/** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** @description The name of the tag. */
- readonly tag_name: string;
+ tag_name: string;
/** Format: uri */
- readonly tarball_url: string | null;
+ tarball_url: string | null;
/** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
+ target_commitish: string;
+ /** Format: date-time */
+ updated_at: string | null;
/** Format: uri-template */
- readonly upload_url: string;
+ upload_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly zipball_url: string | null;
+ zipball_url: string | null;
};
/**
* Repository Vulnerability Alert Alert
* @description The security alert of the vulnerable dependency.
*/
- readonly webhooks_alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
+ webhooks_alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_reason?: string;
+ dismissed_at?: string;
/** User */
- readonly dismisser?: {
+ dismisser?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
- readonly external_identifier: string;
+ external_identifier: string;
/** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
+ external_reference: string | null;
+ fix_reason?: string;
/** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
/** @enum {string} */
- readonly state: "open";
+ state: "auto_dismissed" | "open";
};
/**
* @description The reason for resolving the alert.
* @enum {string|null}
*/
- readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null;
- readonly "secret-scanning-alert-webhook": {
- readonly number?: components["schemas"]["alert-number"];
- readonly created_at?: components["schemas"]["alert-created-at"];
- readonly updated_at?: components["schemas"]["nullable-alert-updated-at"];
- readonly url?: components["schemas"]["alert-url"];
- readonly html_url?: components["schemas"]["alert-html-url"];
+ "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null;
+ "secret-scanning-alert-webhook": {
+ number?: components["schemas"]["alert-number"];
+ created_at?: components["schemas"]["alert-created-at"];
+ updated_at?: components["schemas"]["nullable-alert-updated-at"];
+ url?: components["schemas"]["alert-url"];
+ html_url?: components["schemas"]["alert-html-url"];
/**
* Format: uri
* @description The REST API URL of the code locations for this alert.
*/
- readonly locations_url?: string;
- readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
+ locations_url?: string;
+ resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"];
/**
* Format: date-time
* @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly resolved_at?: string | null;
- readonly resolved_by?: components["schemas"]["nullable-simple-user"];
+ resolved_at?: string | null;
+ resolved_by?: components["schemas"]["nullable-simple-user"];
/** @description An optional comment to resolve an alert. */
- readonly resolution_comment?: string | null;
+ resolution_comment?: string | null;
/** @description The type of secret that secret scanning detected. */
- readonly secret_type?: string;
+ secret_type?: string;
/**
* @description User-friendly name for the detected secret, matching the `secret_type`.
* For a list of built-in patterns, see "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)."
*/
- readonly secret_type_display_name?: string;
+ secret_type_display_name?: string;
/**
* @description The token status as of the latest validity check.
* @enum {string}
*/
- readonly validity?: "active" | "inactive" | "unknown";
+ validity?: "active" | "inactive" | "unknown";
/** @description Whether push protection was bypassed for the detected secret. */
- readonly push_protection_bypassed?: boolean | null;
- readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
+ push_protection_bypassed?: boolean | null;
+ push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"];
/**
* Format: date-time
* @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly push_protection_bypassed_at?: string | null;
- readonly push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"];
+ push_protection_bypassed_at?: string | null;
+ push_protection_bypass_request_reviewer?: components["schemas"]["nullable-simple-user"];
/** @description An optional comment when reviewing a push protection bypass. */
- readonly push_protection_bypass_request_reviewer_comment?: string | null;
+ push_protection_bypass_request_reviewer_comment?: string | null;
/** @description An optional comment when requesting a push protection bypass. */
- readonly push_protection_bypass_request_comment?: string | null;
+ push_protection_bypass_request_comment?: string | null;
/**
* Format: uri
* @description The URL to a push protection bypass request.
*/
- readonly push_protection_bypass_request_html_url?: string | null;
+ push_protection_bypass_request_html_url?: string | null;
/** @description Whether the detected secret was publicly leaked. */
- readonly publicly_leaked?: boolean | null;
+ publicly_leaked?: boolean | null;
/** @description Whether the detected secret was found in multiple repositories in the same organization or business. */
- readonly multi_repo?: boolean | null;
+ multi_repo?: boolean | null;
+ assigned_to?: components["schemas"]["nullable-simple-user"];
};
/** @description The details of the security advisory, including summary, description, and severity. */
- readonly webhooks_security_advisory: {
- readonly cvss: {
- readonly score: number;
- readonly vector_string: string | null;
- };
- readonly cvss_severities?: components["schemas"]["cvss-severities"];
- readonly cwes: readonly {
- readonly cwe_id: string;
- readonly name: string;
+ webhooks_security_advisory: {
+ cvss: {
+ score: number;
+ vector_string: string | null;
+ };
+ cvss_severities?: components["schemas"]["cvss-severities"];
+ cwes: {
+ cwe_id: string;
+ name: string;
}[];
- readonly description: string;
- readonly ghsa_id: string;
- readonly identifiers: readonly {
- readonly type: string;
- readonly value: string;
+ description: string;
+ ghsa_id: string;
+ identifiers: {
+ type: string;
+ value: string;
}[];
- readonly published_at: string;
- readonly references: readonly {
+ published_at: string;
+ references: {
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly severity: string;
- readonly summary: string;
- readonly updated_at: string;
- readonly vulnerabilities: readonly {
- readonly first_patched_version: {
- readonly identifier: string;
+ severity: string;
+ summary: string;
+ updated_at: string;
+ vulnerabilities: {
+ first_patched_version: {
+ identifier: string;
} | null;
- readonly package: {
- readonly ecosystem: string;
- readonly name: string;
+ package: {
+ ecosystem: string;
+ name: string;
};
- readonly severity: string;
- readonly vulnerable_version_range: string;
+ severity: string;
+ vulnerable_version_range: string;
}[];
- readonly withdrawn_at: string | null;
- };
- readonly webhooks_sponsorship: {
- readonly created_at: string;
- readonly maintainer?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
- };
- readonly node_id: string;
- readonly privacy_level: string;
+ withdrawn_at: string | null;
+ };
+ webhooks_sponsorship: {
+ created_at: string;
+ maintainer?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ node_id: string;
+ privacy_level: string;
/** User */
- readonly sponsor: {
+ sponsor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** User */
- readonly sponsorable: {
+ sponsorable: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Sponsorship Tier
* @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
*/
- readonly tier: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
+ tier: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
};
};
/** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */
- readonly webhooks_effective_date: string;
- readonly webhooks_changes_8: {
- readonly tier: {
+ webhooks_effective_date: string;
+ webhooks_changes_8: {
+ tier: {
/**
* Sponsorship Tier
* @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload.
*/
- readonly from: {
- readonly created_at: string;
- readonly description: string;
- readonly is_custom_ammount?: boolean;
- readonly is_custom_amount?: boolean;
- readonly is_one_time: boolean;
- readonly monthly_price_in_cents: number;
- readonly monthly_price_in_dollars: number;
- readonly name: string;
- readonly node_id: string;
+ from: {
+ created_at: string;
+ description: string;
+ is_custom_ammount?: boolean;
+ is_custom_amount?: boolean;
+ is_one_time: boolean;
+ monthly_price_in_cents: number;
+ monthly_price_in_dollars: number;
+ name: string;
+ node_id: string;
};
};
};
@@ -40309,14583 +43085,15980 @@ export type components = {
* Team
* @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly webhooks_team_1: {
- readonly deleted?: boolean;
+ webhooks_team_1: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/**
* @description Whether team members will receive notifications when their team is @mentioned
* @enum {string}
*/
- readonly notification_setting: "notifications_enabled" | "notifications_disabled";
+ notification_setting: "notifications_enabled" | "notifications_disabled";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
+ /**
+ * @description The ownership type of the team
+ * @enum {string}
+ */
+ type: "enterprise" | "organization";
+ /**
+ * @description Unique identifier of the organization to which this team belongs
+ * @example 37
+ */
+ organization_id?: number;
+ /**
+ * @description Unique identifier of the enterprise to which this team belongs
+ * @example 42
+ */
+ enterprise_id?: number;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/**
* @description Whether team members will receive notifications when their team is @mentioned
* @enum {string}
*/
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
+ /**
+ * @description The ownership type of the team
+ * @enum {string}
+ */
+ type?: "enterprise" | "organization";
+ /**
+ * @description Unique identifier of the organization to which this team belongs
+ * @example 37
+ */
+ organization_id?: number;
+ /**
+ * @description Unique identifier of the enterprise to which this team belongs
+ * @example 42
+ */
+ enterprise_id?: number;
};
/** branch protection configuration disabled event */
- readonly "webhook-branch-protection-configuration-disabled": {
+ "webhook-branch-protection-configuration-disabled": {
/** @enum {string} */
- readonly action: "disabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "disabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** branch protection configuration enabled event */
- readonly "webhook-branch-protection-configuration-enabled": {
+ "webhook-branch-protection-configuration-enabled": {
/** @enum {string} */
- readonly action: "enabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "enabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** branch protection rule created event */
- readonly "webhook-branch-protection-rule-created": {
+ "webhook-branch-protection-rule-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly rule: components["schemas"]["webhooks_rule"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ rule: components["schemas"]["webhooks_rule"];
+ sender: components["schemas"]["simple-user"];
};
/** branch protection rule deleted event */
- readonly "webhook-branch-protection-rule-deleted": {
+ "webhook-branch-protection-rule-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly rule: components["schemas"]["webhooks_rule"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ rule: components["schemas"]["webhooks_rule"];
+ sender: components["schemas"]["simple-user"];
};
/** branch protection rule edited event */
- readonly "webhook-branch-protection-rule-edited": {
+ "webhook-branch-protection-rule-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description If the action was `edited`, the changes to the rule. */
- readonly changes?: {
- readonly admin_enforced?: {
- readonly from: boolean | null;
+ changes?: {
+ admin_enforced?: {
+ from: boolean | null;
};
- readonly authorized_actor_names?: {
- readonly from: readonly string[];
+ authorized_actor_names?: {
+ from: string[];
};
- readonly authorized_actors_only?: {
- readonly from: boolean | null;
+ authorized_actors_only?: {
+ from: boolean | null;
};
- readonly authorized_dismissal_actors_only?: {
- readonly from: boolean | null;
+ authorized_dismissal_actors_only?: {
+ from: boolean | null;
};
- readonly linear_history_requirement_enforcement_level?: {
+ linear_history_requirement_enforcement_level?: {
/** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
+ from: "off" | "non_admins" | "everyone";
};
- readonly lock_branch_enforcement_level?: {
+ lock_branch_enforcement_level?: {
/** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
+ from: "off" | "non_admins" | "everyone";
};
- readonly lock_allows_fork_sync?: {
- readonly from: boolean | null;
+ lock_allows_fork_sync?: {
+ from: boolean | null;
};
- readonly pull_request_reviews_enforcement_level?: {
+ pull_request_reviews_enforcement_level?: {
/** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
+ from: "off" | "non_admins" | "everyone";
};
- readonly require_last_push_approval?: {
- readonly from: boolean | null;
+ require_last_push_approval?: {
+ from: boolean | null;
};
- readonly required_status_checks?: {
- readonly from: readonly string[];
+ required_status_checks?: {
+ from: string[];
};
- readonly required_status_checks_enforcement_level?: {
+ required_status_checks_enforcement_level?: {
/** @enum {string} */
- readonly from: "off" | "non_admins" | "everyone";
+ from: "off" | "non_admins" | "everyone";
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly rule: components["schemas"]["webhooks_rule"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ rule: components["schemas"]["webhooks_rule"];
+ sender: components["schemas"]["simple-user"];
};
/** Check Run Completed Event */
- readonly "webhook-check-run-completed": {
+ "webhook-check-run-completed": {
/** @enum {string} */
- readonly action?: "completed";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action?: "completed";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/**
* Check Run Completed Event
* @description The check_run.completed webhook encoded with URL encoding
*/
- readonly "webhook-check-run-completed-form-encoded": {
+ "webhook-check-run-completed-form-encoded": {
/** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** Check Run Created Event */
- readonly "webhook-check-run-created": {
+ "webhook-check-run-created": {
/** @enum {string} */
- readonly action?: "created";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action?: "created";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/**
* Check Run Created Event
* @description The check_run.created webhook encoded with URL encoding
*/
- readonly "webhook-check-run-created-form-encoded": {
+ "webhook-check-run-created-form-encoded": {
/** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** Check Run Requested Action Event */
- readonly "webhook-check-run-requested-action": {
+ "webhook-check-run-requested-action": {
/** @enum {string} */
- readonly action: "requested_action";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
+ action: "requested_action";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The action requested by the user. */
- readonly requested_action?: {
+ requested_action?: {
/** @description The integrator reference of the action requested by the user. */
- readonly identifier?: string;
+ identifier?: string;
};
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
};
/**
* Check Run Requested Action Event
* @description The check_run.requested_action webhook encoded with URL encoding
*/
- readonly "webhook-check-run-requested-action-form-encoded": {
+ "webhook-check-run-requested-action-form-encoded": {
/** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** Check Run Re-Requested Event */
- readonly "webhook-check-run-rerequested": {
+ "webhook-check-run-rerequested": {
/** @enum {string} */
- readonly action?: "rerequested";
- readonly check_run: components["schemas"]["check-run-with-simple-check-suite"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action?: "rerequested";
+ check_run: components["schemas"]["check-run-with-simple-check-suite"];
+ installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/**
* Check Run Re-Requested Event
* @description The check_run.rerequested webhook encoded with URL encoding
*/
- readonly "webhook-check-run-rerequested-form-encoded": {
+ "webhook-check-run-rerequested-form-encoded": {
/** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** check_suite completed event */
- readonly "webhook-check-suite-completed": {
+ "webhook-check-suite-completed": {
/** @enum {string} */
- readonly action: "completed";
+ action: "completed";
/** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
+ check_suite: {
+ after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly app: {
+ app: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The client ID of the GitHub app */
- readonly client_id?: string | null;
+ client_id?: string | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
};
- readonly before: string | null;
+ before: string | null;
/** Format: uri */
- readonly check_runs_url: string;
+ check_runs_url: string;
/**
* @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
/** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
/**
* @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
* @enum {string|null}
*/
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | null | "pending";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL that points to the check suite API resource.
*/
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** check_suite requested event */
- readonly "webhook-check-suite-requested": {
+ "webhook-check-suite-requested": {
/** @enum {string} */
- readonly action: "requested";
+ action: "requested";
/** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
+ check_suite: {
+ after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly app: {
+ app: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description Client ID of the GitHub app */
- readonly client_id?: string | null;
+ client_id?: string | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
/** @enum {string} */
- readonly actions?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ artifact_metadata?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ attestations?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ copilot_requests?: "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ merge_queues?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ models?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
};
- readonly before: string | null;
+ before: string | null;
/** Format: uri */
- readonly check_runs_url: string;
+ check_runs_url: string;
/**
* @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped";
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
/** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
/**
* @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
* @enum {string|null}
*/
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
+ status: "requested" | "in_progress" | "completed" | "queued" | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL that points to the check suite API resource.
*/
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** check_suite rerequested event */
- readonly "webhook-check-suite-rerequested": {
+ "webhook-check-suite-rerequested": {
/** @enum {string} */
- readonly action: "rerequested";
+ action: "rerequested";
/** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */
- readonly check_suite: {
- readonly after: string | null;
+ check_suite: {
+ after: string | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly app: {
+ app: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The Client ID for the GitHub app */
- readonly client_id?: string | null;
+ client_id?: string | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ artifact_metadata?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ attestations?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ copilot_requests?: "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ merge_queues?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ models?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
};
- readonly before: string | null;
+ before: string | null;
/** Format: uri */
- readonly check_runs_url: string;
+ check_runs_url: string;
/**
* @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The head branch name the changes are on. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** @description The SHA of the head commit that is being checked. */
- readonly head_sha: string;
- readonly id: number;
- readonly latest_check_runs_count: number;
- readonly node_id: string;
+ head_sha: string;
+ id: number;
+ latest_check_runs_count: number;
+ node_id: string;
/** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly rerequestable?: boolean;
- readonly runs_rerequestable?: boolean;
+ rerequestable?: boolean;
+ runs_rerequestable?: boolean;
/**
* @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`.
* @enum {string|null}
*/
- readonly status: "requested" | "in_progress" | "completed" | "queued" | null;
+ status: "requested" | "in_progress" | "completed" | "queued" | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL that points to the check suite API resource.
*/
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert appeared_in_branch event */
- readonly "webhook-code-scanning-alert-appeared-in-branch": {
+ "webhook-code-scanning-alert-appeared-in-branch": {
/** @enum {string} */
- readonly action: "appeared_in_branch";
+ action: "appeared_in_branch";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly dismissed_at: string | null;
+ dismissed_at: string | null;
/** User */
- readonly dismissed_by: {
+ dismissed_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/**
* @description The reason for dismissing or closing the alert.
* @enum {string|null}
*/
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
+ html_url: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
+ description: string;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
+ id: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
+ severity: "none" | "note" | "warning" | "error" | null;
};
/**
* @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
* @enum {string|null}
*/
- readonly state: "open" | "dismissed" | "fixed" | null;
- readonly tool: {
+ state: "open" | "dismissed" | "fixed" | null;
+ tool: {
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
};
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: components["schemas"]["webhooks_code_scanning_ref"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert closed_by_user event */
- readonly "webhook-code-scanning-alert-closed-by-user": {
+ "webhook-code-scanning-alert-closed-by-user": {
/** @enum {string} */
- readonly action: "closed_by_user";
+ action: "closed_by_user";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly dismissed_at: string;
+ dismissed_at: string;
/** User */
- readonly dismissed_by: {
+ dismissed_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/**
* @description The reason for dismissing or closing the alert.
* @enum {string|null}
*/
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
+ html_url: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
+ description: string;
+ full_description?: string;
+ help?: string | null;
/** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
+ help_uri?: string | null;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
+ id: string;
+ name?: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: readonly string[] | null;
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
};
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "dismissed" | "fixed";
- readonly tool: {
- readonly guid?: string | null;
+ state: "dismissed" | "fixed";
+ tool: {
+ guid?: string | null;
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
};
/** Format: uri */
- readonly url: string;
+ url: string;
+ /** User */
+ dismissal_approved_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;
+ user_view_type?: string;
+ } | null;
};
- readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: components["schemas"]["webhooks_code_scanning_ref"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert created event */
- readonly "webhook-code-scanning-alert-created": {
+ "webhook-code-scanning-alert-created": {
/** @enum {string} */
- readonly action: "created";
+ action: "created";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string | null;
+ created_at: string | null;
/** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_at: unknown;
+ dismissed_by: unknown;
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
+ dismissed_reason: unknown;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
- readonly instances_url?: string;
+ html_url: string;
+ instances_url?: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
+ description: string;
+ full_description?: string;
+ help?: string | null;
/** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
+ help_uri?: string | null;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
+ id: string;
+ name?: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: readonly string[] | null;
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
};
/**
* @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
* @enum {string|null}
*/
- readonly state: "open" | "dismissed" | null;
- readonly tool: {
- readonly guid?: string | null;
+ state: "open" | "dismissed" | null;
+ tool: {
+ guid?: string | null;
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
} | null;
- readonly updated_at?: string | null;
+ updated_at?: string | null;
/** Format: uri */
- readonly url: string;
+ url: string;
+ dismissal_approved_by?: unknown;
+ assignees?: components["schemas"]["simple-user"][];
};
- readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: components["schemas"]["webhooks_code_scanning_ref"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert fixed event */
- readonly "webhook-code-scanning-alert-fixed": {
+ "webhook-code-scanning-alert-fixed": {
/** @enum {string} */
- readonly action: "fixed";
+ action: "fixed";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string;
+ created_at: string;
/**
* Format: date-time
* @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly dismissed_at: string | null;
+ dismissed_at: string | null;
/** User */
- readonly dismissed_by: {
+ dismissed_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/**
* @description The reason for dismissing or closing the alert.
* @enum {string|null}
*/
- readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
+ html_url: string;
/** Format: uri */
- readonly instances_url?: string;
+ instances_url?: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
+ description: string;
+ full_description?: string;
+ help?: string | null;
/** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
+ help_uri?: string | null;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
+ id: string;
+ name?: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: readonly string[] | null;
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
};
/**
* @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
* @enum {string|null}
*/
- readonly state: "fixed" | null;
- readonly tool: {
- readonly guid?: string | null;
+ state: "fixed" | null;
+ tool: {
+ guid?: string | null;
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
};
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: components["schemas"]["webhooks_code_scanning_ref"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert reopened event */
- readonly "webhook-code-scanning-alert-reopened": {
+ "webhook-code-scanning-alert-reopened": {
/** @enum {string} */
- readonly action: "reopened";
+ action: "reopened";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string;
+ created_at: string;
/** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: string | null;
- readonly dismissed_by: Record | null;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_at: string | null;
+ dismissed_by: Record | null;
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: string | null;
+ dismissed_reason: string | null;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
+ html_url: string;
+ instances_url?: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
- readonly full_description?: string;
- readonly help?: string | null;
+ description: string;
+ full_description?: string;
+ help?: string | null;
/** @description A link to the documentation for the rule used to detect the alert. */
- readonly help_uri?: string | null;
+ help_uri?: string | null;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
- readonly name?: string;
+ id: string;
+ name?: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
- readonly tags?: readonly string[] | null;
+ severity: "none" | "note" | "warning" | "error" | null;
+ tags?: string[] | null;
};
/**
* @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
* @enum {string|null}
*/
- readonly state: "open" | "dismissed" | "fixed" | null;
- readonly tool: {
- readonly guid?: string | null;
+ state: "open" | "dismissed" | "fixed" | null;
+ tool: {
+ guid?: string | null;
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
};
+ updated_at?: string | null;
/** Format: uri */
- readonly url: string;
- } | null;
+ url: string;
+ dismissal_approved_by?: unknown;
+ };
/** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */
- readonly commit_oid: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ commit_oid: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ 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. */
- readonly ref: string | null;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ ref: string | null;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** code_scanning_alert reopened_by_user event */
- readonly "webhook-code-scanning-alert-reopened-by-user": {
+ "webhook-code-scanning-alert-reopened-by-user": {
/** @enum {string} */
- readonly action: "reopened_by_user";
+ action: "reopened_by_user";
/** @description The code scanning alert involved in the event. */
- readonly alert: {
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
/**
* Format: date-time
* @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
*/
- readonly created_at: string;
+ created_at: string;
/** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly dismissed_at: unknown;
- readonly dismissed_by: unknown;
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ dismissed_at: unknown;
+ dismissed_by: unknown;
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
/** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */
- readonly dismissed_reason: unknown;
+ dismissed_reason: unknown;
/** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly fixed_at?: unknown;
+ fixed_at?: unknown;
/**
* Format: uri
* @description The GitHub URL of the alert resource.
*/
- readonly html_url: string;
+ html_url: string;
/** Alert Instance */
- readonly most_recent_instance?: {
+ most_recent_instance?: {
/** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
- readonly analysis_key: string;
+ analysis_key: string;
/** @description Identifies the configuration under which the analysis was executed. */
- readonly category?: string;
- readonly classifications?: readonly string[];
- readonly commit_sha?: string;
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
/** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
- readonly environment: string;
- readonly location?: {
- readonly end_column?: number;
- readonly end_line?: number;
- readonly path?: string;
- readonly start_column?: number;
- readonly start_line?: number;
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
};
- readonly message?: {
- readonly text?: string;
+ message?: {
+ text?: string;
};
/** @description The full Git reference, formatted as `refs/heads/`. */
- readonly ref: string;
+ ref: string;
/**
* @description State of a code scanning alert.
* @enum {string}
*/
- readonly state: "open" | "dismissed" | "fixed";
+ state: "open" | "dismissed" | "fixed";
} | null;
/** @description The code scanning alert number. */
- readonly number: number;
- readonly rule: {
+ number: number;
+ rule: {
/** @description A short description of the rule used to detect the alert. */
- readonly description: string;
+ description: string;
/** @description A unique identifier for the rule used to detect the alert. */
- readonly id: string;
+ id: string;
/**
* @description The severity of the alert.
* @enum {string|null}
*/
- readonly severity: "none" | "note" | "warning" | "error" | null;
+ severity: "none" | "note" | "warning" | "error" | null;
};
/**
* @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
* @enum {string|null}
*/
- readonly state: "open" | "fixed" | null;
- readonly tool: {
+ state: "open" | "fixed" | null;
+ tool: {
/** @description The name of the tool used to generate the code scanning analysis alert. */
- readonly name: string;
+ name: string;
/** @description The version of the tool used to detect the alert. */
- readonly version: string | null;
+ version: string | null;
};
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: components["schemas"]["webhooks_code_scanning_ref"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: components["schemas"]["webhooks_code_scanning_ref"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** code_scanning_alert updated_assignment event */
+ "webhook-code-scanning-alert-updated-assignment": {
+ /** @enum {string} */
+ action: "updated_assignment";
+ /** @description The code scanning alert involved in the event. */
+ alert: {
+ assignees?: components["schemas"]["simple-user"][];
+ /**
+ * Format: date-time
+ * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.`
+ */
+ created_at: string;
+ /**
+ * Format: date-time
+ * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
+ */
+ dismissed_at: string | null;
+ /** User */
+ dismissed_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;
+ user_view_type?: string;
+ } | null;
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ /**
+ * @description The reason for dismissing or closing the alert.
+ * @enum {string|null}
+ */
+ dismissed_reason: "false positive" | "won't fix" | "used in tests" | null;
+ /** @description The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */
+ fixed_at?: unknown;
+ /**
+ * Format: uri
+ * @description The GitHub URL of the alert resource.
+ */
+ html_url: string;
+ /** Alert Instance */
+ most_recent_instance?: {
+ /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */
+ analysis_key: string;
+ /** @description Identifies the configuration under which the analysis was executed. */
+ category?: string;
+ classifications?: string[];
+ commit_sha?: string;
+ /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */
+ environment: string;
+ location?: {
+ end_column?: number;
+ end_line?: number;
+ path?: string;
+ start_column?: number;
+ start_line?: number;
+ };
+ message?: {
+ text?: string;
+ };
+ /** @description The full Git reference, formatted as `refs/heads/`. */
+ ref: string;
+ /**
+ * @description State of a code scanning alert.
+ * @enum {string}
+ */
+ state: "open" | "dismissed" | "fixed";
+ } | null;
+ /** @description The code scanning alert number. */
+ number: number;
+ rule: {
+ /** @description A short description of the rule used to detect the alert. */
+ description: string;
+ /** @description A unique identifier for the rule used to detect the alert. */
+ id: string;
+ /**
+ * @description The severity of the alert.
+ * @enum {string|null}
+ */
+ severity: "none" | "note" | "warning" | "error" | null;
+ };
+ /**
+ * @description State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.
+ * @enum {string|null}
+ */
+ state: "open" | "dismissed" | "fixed" | null;
+ tool: {
+ /** @description The name of the tool used to generate the code scanning analysis alert. */
+ name: string;
+ /** @description The version of the tool used to detect the alert. */
+ version: string | null;
+ };
+ /** Format: uri */
+ url: string;
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** commit_comment created event */
- readonly "webhook-commit-comment-created": {
+ "webhook-commit-comment-created": {
/**
* @description The action performed. Can be `created`.
* @enum {string}
*/
- readonly action: "created";
+ action: "created";
/** @description The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/rest/commits/comments#get-a-commit-comment) resource. */
- readonly comment: {
+ comment: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the comment. */
- readonly body: string;
+ body: string;
/** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
- readonly created_at: string;
+ commit_id: string;
+ created_at: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description The ID of the commit comment. */
- readonly id: number;
+ id: number;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
+ line: number | null;
/** @description The node ID of the commit comment. */
- readonly node_id: string;
+ node_id: string;
/** @description The relative path of the file to which the comment applies. */
- readonly path: string | null;
+ path: string | null;
/** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
+ position: number | null;
/** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- readonly updated_at: string;
- /** Format: uri */
- readonly url: string;
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ updated_at: string;
+ /** Format: uri */
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** create event */
- readonly "webhook-create": {
+ "webhook-create": {
/** @description The repository's current description. */
- readonly description: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ description: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The name of the repository's default branch (usually `main`). */
- readonly master_branch: string;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
- readonly ref: components["schemas"]["webhooks_ref_0"];
+ master_branch: string;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ ref: components["schemas"]["webhooks_ref_0"];
/**
* @description The type of Git ref object created in the repository.
* @enum {string}
*/
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ ref_type: "tag" | "branch";
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** custom property created event */
- readonly "webhook-custom-property-created": {
+ "webhook-custom-property-created": {
/** @enum {string} */
- readonly action: "created";
- readonly definition: components["schemas"]["custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "created";
+ definition: components["schemas"]["custom-property"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** custom property deleted event */
- readonly "webhook-custom-property-deleted": {
+ "webhook-custom-property-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly definition: {
+ action: "deleted";
+ definition: {
/** @description The name of the property that was deleted. */
- readonly property_name: string;
+ property_name: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ };
+ /** custom property promoted to business event */
+ "webhook-custom-property-promoted-to-enterprise": {
+ /** @enum {string} */
+ action: "promote_to_enterprise";
+ definition: components["schemas"]["custom-property"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** custom property updated event */
- readonly "webhook-custom-property-updated": {
+ "webhook-custom-property-updated": {
/** @enum {string} */
- readonly action: "updated";
- readonly definition: components["schemas"]["custom-property"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "updated";
+ definition: components["schemas"]["custom-property"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** Custom property values updated event */
- readonly "webhook-custom-property-values-updated": {
+ "webhook-custom-property-values-updated": {
/** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ repository: components["schemas"]["repository-webhooks"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
/** @description The new custom property values for the repository. */
- readonly new_property_values: readonly components["schemas"]["custom-property-value"][];
+ new_property_values: components["schemas"]["custom-property-value"][];
/** @description The old custom property values for the repository. */
- readonly old_property_values: readonly components["schemas"]["custom-property-value"][];
+ old_property_values: components["schemas"]["custom-property-value"][];
};
/** delete event */
- readonly "webhook-delete": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
- readonly ref: components["schemas"]["webhooks_ref_0"];
+ "webhook-delete": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pusher_type: components["schemas"]["webhooks_deploy_pusher_type"];
+ ref: components["schemas"]["webhooks_ref_0"];
/**
* @description The type of Git ref object deleted in the repository.
* @enum {string}
*/
- readonly ref_type: "tag" | "branch";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ ref_type: "tag" | "branch";
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** Dependabot alert assignees changed event */
+ "webhook-dependabot-alert-assignees-changed": {
+ /** @enum {string} */
+ action: "assignees_changed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert auto-dismissed event */
- readonly "webhook-dependabot-alert-auto-dismissed": {
+ "webhook-dependabot-alert-auto-dismissed": {
/** @enum {string} */
- readonly action: "auto_dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "auto_dismissed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert auto-reopened event */
- readonly "webhook-dependabot-alert-auto-reopened": {
+ "webhook-dependabot-alert-auto-reopened": {
/** @enum {string} */
- readonly action: "auto_reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "auto_reopened";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert created event */
- readonly "webhook-dependabot-alert-created": {
+ "webhook-dependabot-alert-created": {
/** @enum {string} */
- readonly action: "created";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert dismissed event */
- readonly "webhook-dependabot-alert-dismissed": {
+ "webhook-dependabot-alert-dismissed": {
/** @enum {string} */
- readonly action: "dismissed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "dismissed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert fixed event */
- readonly "webhook-dependabot-alert-fixed": {
+ "webhook-dependabot-alert-fixed": {
/** @enum {string} */
- readonly action: "fixed";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "fixed";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert reintroduced event */
- readonly "webhook-dependabot-alert-reintroduced": {
+ "webhook-dependabot-alert-reintroduced": {
/** @enum {string} */
- readonly action: "reintroduced";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reintroduced";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Dependabot alert reopened event */
- readonly "webhook-dependabot-alert-reopened": {
+ "webhook-dependabot-alert-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly alert: components["schemas"]["dependabot-alert"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopened";
+ alert: components["schemas"]["dependabot-alert"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** deploy_key created event */
- readonly "webhook-deploy-key-created": {
+ "webhook-deploy-key-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly key: components["schemas"]["webhooks_deploy_key"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ key: components["schemas"]["webhooks_deploy_key"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** deploy_key deleted event */
- readonly "webhook-deploy-key-deleted": {
+ "webhook-deploy-key-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly key: components["schemas"]["webhooks_deploy_key"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ key: components["schemas"]["webhooks_deploy_key"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** deployment created event */
- readonly "webhook-deployment-created": {
+ "webhook-deployment-created": {
/** @enum {string} */
- readonly action: "created";
+ action: "created";
/**
* Deployment
* @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
*/
- readonly deployment: {
- readonly created_at: string;
+ deployment: {
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: Record | string;
+ description: string | null;
+ environment: string;
+ id: number;
+ node_id: string;
+ original_environment: string;
+ payload: Record | string;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly production_environment?: boolean;
- readonly ref: string;
+ production_environment?: boolean;
+ ref: string;
/** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
+ repository_url: string;
+ sha: string;
/** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
+ statuses_url: string;
+ task: string;
+ transient_environment?: boolean;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow: components["schemas"]["webhooks_workflow"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow: components["schemas"]["webhooks_workflow"];
/** Deployment Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: unknown;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ repository?: {
+ 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;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly triggering_actor?: {
+ triggering_actor?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
} | null;
};
/** deployment protection rule requested event */
- readonly "webhook-deployment-protection-rule-requested": {
+ "webhook-deployment-protection-rule-requested": {
/** @enum {string} */
- readonly action?: "requested";
+ action?: "requested";
/** @description The name of the environment that has the deployment protection rule. */
- readonly environment?: string;
+ environment?: string;
/** @description The event that triggered the deployment protection rule. */
- readonly event?: string;
+ event?: string;
+ /** @description The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */
+ sha?: string;
+ /** @description The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. */
+ ref?: string;
/**
* Format: uri
* @description The URL to review the deployment protection rule.
*/
- readonly deployment_callback_url?: string;
- readonly deployment?: components["schemas"]["deployment"];
- readonly pull_requests?: readonly components["schemas"]["pull-request"][];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly sender?: components["schemas"]["simple-user"];
+ deployment_callback_url?: string;
+ deployment?: components["schemas"]["nullable-deployment"];
+ pull_requests?: components["schemas"]["pull-request"][];
+ repository?: components["schemas"]["repository-webhooks"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ sender?: components["schemas"]["simple-user"];
};
- readonly "webhook-deployment-review-approved": {
+ "webhook-deployment-review-approved": {
/** @enum {string} */
- readonly action: "approved";
- readonly approver?: components["schemas"]["webhooks_approver"];
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: components["schemas"]["webhooks_reviewers"];
- readonly sender: components["schemas"]["simple-user"];
- readonly since: string;
- readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
- readonly workflow_job_runs?: readonly {
- readonly conclusion?: unknown;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
+ action: "approved";
+ approver?: components["schemas"]["webhooks_approver"];
+ comment?: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ reviewers?: components["schemas"]["webhooks_reviewers"];
+ sender: components["schemas"]["simple-user"];
+ since: string;
+ workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ workflow_job_runs?: {
+ conclusion?: unknown;
+ created_at?: string;
+ environment?: string;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ status?: string;
+ updated_at?: string;
}[];
/** Deployment Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record | null;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: Record | null;
+ head_repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
} | null;
};
- readonly "webhook-deployment-review-rejected": {
+ "webhook-deployment-review-rejected": {
/** @enum {string} */
- readonly action: "rejected";
- readonly approver?: components["schemas"]["webhooks_approver"];
- readonly comment?: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly reviewers?: components["schemas"]["webhooks_reviewers"];
- readonly sender: components["schemas"]["simple-user"];
- readonly since: string;
- readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
- readonly workflow_job_runs?: readonly {
- readonly conclusion?: string | null;
- readonly created_at?: string;
- readonly environment?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly status?: string;
- readonly updated_at?: string;
+ action: "rejected";
+ approver?: components["schemas"]["webhooks_approver"];
+ comment?: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ reviewers?: components["schemas"]["webhooks_reviewers"];
+ sender: components["schemas"]["simple-user"];
+ since: string;
+ workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"];
+ workflow_job_runs?: {
+ conclusion?: string | null;
+ created_at?: string;
+ environment?: string;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ status?: string;
+ updated_at?: string;
}[];
/** Deployment Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record | null;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ created_at: string;
+ event: string;
+ head_branch: string;
+ head_commit?: Record | null;
+ head_repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
+ status: "requested" | "in_progress" | "completed" | "queued" | "waiting";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ display_title: string;
} | null;
};
- readonly "webhook-deployment-review-requested": {
+ "webhook-deployment-review-requested": {
/** @enum {string} */
- readonly action: "requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly environment: string;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly requestor: components["schemas"]["webhooks_user"];
- readonly reviewers: readonly {
+ action: "requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ environment: string;
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ requestor: components["schemas"]["webhooks_user"];
+ reviewers: {
/** User */
- readonly reviewer?: {
+ reviewer?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login?: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login?: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @enum {string} */
- readonly type?: "User" | "Team";
+ type?: "User" | "Team";
}[];
- readonly sender: components["schemas"]["simple-user"];
- readonly since: string;
- readonly workflow_job_run: {
- readonly conclusion: unknown;
- readonly created_at: string;
- readonly environment: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly status: string;
- readonly updated_at: string;
+ sender: components["schemas"]["simple-user"];
+ since: string;
+ workflow_job_run: {
+ conclusion: unknown;
+ created_at: string;
+ environment: string;
+ html_url: string;
+ id: number;
+ name: string | null;
+ status: string;
+ updated_at: string;
};
/** Deployment Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: Record | null;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ created_at: string;
+ event: string;
+ head_branch: string;
+ head_commit?: Record | null;
+ head_repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: string | null;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ repository?: {
+ 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;
+ description?: string | null;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
- readonly display_title: string;
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
+ display_title: string;
} | null;
};
/** deployment_status created event */
- readonly "webhook-deployment-status-created": {
+ "webhook-deployment-status-created": {
/** @enum {string} */
- readonly action: "created";
- readonly check_run?: {
+ action: "created";
+ check_run?: {
/** Format: date-time */
- readonly completed_at: string | null;
+ completed_at: string | null;
/**
* @description The result of the completed check run. This value will be `null` until the check run has completed.
* @enum {string|null}
*/
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null;
/** Format: uri */
- readonly details_url: string;
- readonly external_id: string;
+ details_url: string;
+ external_id: string;
/** @description The SHA of the commit that is being checked. */
- readonly head_sha: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description The id of the check. */
- readonly id: number;
+ id: number;
/** @description The name of the check run. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: date-time */
- readonly started_at: string;
+ started_at: string;
/**
* @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`.
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
+ status: "queued" | "in_progress" | "completed" | "waiting" | "pending";
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
/**
* Deployment
* @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments).
*/
- readonly deployment: {
- readonly created_at: string;
+ deployment: {
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
- readonly environment: string;
- readonly id: number;
- readonly node_id: string;
- readonly original_environment: string;
- readonly payload: (string | Record) | null;
+ description: string | null;
+ environment: string;
+ id: number;
+ node_id: string;
+ original_environment: string;
+ payload: (string | Record) | null;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly production_environment?: boolean;
- readonly ref: string;
+ production_environment?: boolean;
+ ref: string;
/** Format: uri */
- readonly repository_url: string;
- readonly sha: string;
+ repository_url: string;
+ sha: string;
/** Format: uri */
- readonly statuses_url: string;
- readonly task: string;
- readonly transient_environment?: boolean;
- readonly updated_at: string;
+ statuses_url: string;
+ task: string;
+ transient_environment?: boolean;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */
- readonly deployment_status: {
- readonly created_at: string;
+ deployment_status: {
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: uri */
- readonly deployment_url: string;
+ deployment_url: string;
/** @description The optional human-readable description added to the status. */
- readonly description: string;
- readonly environment: string;
+ description: string;
+ environment: string;
/** Format: uri */
- readonly environment_url?: string;
- readonly id: number;
+ environment_url?: string;
+ id: number;
/** Format: uri */
- readonly log_url?: string;
- readonly node_id: string;
+ log_url?: string;
+ node_id: string;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
/** Format: uri */
- readonly repository_url: string;
+ repository_url: string;
/** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */
- readonly state: string;
+ state: string;
/** @description The optional link added to the status. */
- readonly target_url: string;
- readonly updated_at: string;
+ target_url: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow?: components["schemas"]["webhooks_workflow"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow?: components["schemas"]["webhooks_workflow"];
/** Deployment Workflow Run */
- readonly workflow_run?: {
+ workflow_run?: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly artifacts_url?: string;
- readonly cancel_url?: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
- readonly check_suite_url?: string;
+ artifacts_url?: string;
+ cancel_url?: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
+ check_suite_url?: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure";
/** Format: date-time */
- readonly created_at: string;
- readonly display_title: string;
- readonly event: string;
- readonly head_branch: string;
- readonly head_commit?: unknown;
- readonly head_repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ created_at: string;
+ display_title: string;
+ event: string;
+ head_branch: string;
+ head_commit?: unknown;
+ head_repository?: {
+ 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;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly jobs_url?: string;
- readonly logs_url?: string;
- readonly name: string;
- readonly node_id: string;
- readonly path: string;
- readonly previous_attempt_url?: unknown;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ jobs_url?: string;
+ logs_url?: string;
+ name: string;
+ node_id: string;
+ path: string;
+ previous_attempt_url?: unknown;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
- readonly repository?: {
- readonly archive_url?: string;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly deployments_url?: string;
- readonly description?: unknown;
- readonly downloads_url?: string;
- readonly events_url?: string;
- readonly fork?: boolean;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly languages_url?: string;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ repository?: {
+ 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;
+ description?: unknown;
+ downloads_url?: string;
+ events_url?: string;
+ fork?: boolean;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ 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;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
};
- readonly private?: boolean;
- readonly pulls_url?: string;
- readonly releases_url?: string;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly trees_url?: string;
- readonly url?: string;
- };
- readonly rerun_url?: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ private?: boolean;
+ pulls_url?: string;
+ releases_url?: string;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ trees_url?: string;
+ url?: string;
+ };
+ rerun_url?: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
- readonly workflow_url?: string;
+ url: string;
+ workflow_id: number;
+ workflow_url?: string;
} | null;
};
/** discussion answered event */
- readonly "webhook-discussion-answered": {
+ "webhook-discussion-answered": {
/** @enum {string} */
- readonly action: "answered";
- readonly answer: components["schemas"]["webhooks_answer"];
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "answered";
+ answer: components["schemas"]["webhooks_answer"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion category changed event */
- readonly "webhook-discussion-category-changed": {
+ "webhook-discussion-category-changed": {
/** @enum {string} */
- readonly action: "category_changed";
- readonly changes: {
- readonly category: {
- readonly from: {
+ action: "category_changed";
+ changes: {
+ category: {
+ from: {
/** Format: date-time */
- readonly created_at: string;
- readonly description: string;
- readonly emoji: string;
- readonly id: number;
- readonly is_answerable: boolean;
- readonly name: string;
- readonly node_id?: string;
- readonly repository_id: number;
- readonly slug: string;
- readonly updated_at: string;
+ 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;
};
};
};
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion closed event */
- readonly "webhook-discussion-closed": {
+ "webhook-discussion-closed": {
/** @enum {string} */
- readonly action: "closed";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "closed";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion_comment created event */
- readonly "webhook-discussion-comment-created": {
+ "webhook-discussion-comment-created": {
/** @enum {string} */
- readonly action: "created";
- readonly comment: components["schemas"]["webhooks_comment"];
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ comment: components["schemas"]["webhooks_comment"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion_comment deleted event */
- readonly "webhook-discussion-comment-deleted": {
+ "webhook-discussion-comment-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly comment: components["schemas"]["webhooks_comment"];
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ comment: components["schemas"]["webhooks_comment"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion_comment edited event */
- readonly "webhook-discussion-comment-edited": {
+ "webhook-discussion-comment-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body: {
- readonly from: string;
+ action: "edited";
+ changes: {
+ body: {
+ from: string;
};
};
- readonly comment: components["schemas"]["webhooks_comment"];
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ comment: components["schemas"]["webhooks_comment"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion created event */
- readonly "webhook-discussion-created": {
+ "webhook-discussion-created": {
/** @enum {string} */
- readonly action: "created";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion deleted event */
- readonly "webhook-discussion-deleted": {
+ "webhook-discussion-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion edited event */
- readonly "webhook-discussion-edited": {
+ "webhook-discussion-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes?: {
- readonly body?: {
- readonly from: string;
+ action: "edited";
+ changes?: {
+ body?: {
+ from: string;
};
- readonly title?: {
- readonly from: string;
+ title?: {
+ from: string;
};
};
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion labeled event */
- readonly "webhook-discussion-labeled": {
+ "webhook-discussion-labeled": {
/** @enum {string} */
- readonly action: "labeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "labeled";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion locked event */
- readonly "webhook-discussion-locked": {
+ "webhook-discussion-locked": {
/** @enum {string} */
- readonly action: "locked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "locked";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion pinned event */
- readonly "webhook-discussion-pinned": {
+ "webhook-discussion-pinned": {
/** @enum {string} */
- readonly action: "pinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "pinned";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion reopened event */
- readonly "webhook-discussion-reopened": {
+ "webhook-discussion-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopened";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion transferred event */
- readonly "webhook-discussion-transferred": {
+ "webhook-discussion-transferred": {
/** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- readonly new_discussion: components["schemas"]["discussion"];
- readonly new_repository: components["schemas"]["repository-webhooks"];
- };
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "transferred";
+ changes: {
+ new_discussion: components["schemas"]["discussion"];
+ new_repository: components["schemas"]["repository-webhooks"];
+ };
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion unanswered event */
- readonly "webhook-discussion-unanswered": {
+ "webhook-discussion-unanswered": {
/** @enum {string} */
- readonly action: "unanswered";
- readonly discussion: components["schemas"]["discussion"];
- readonly old_answer: components["schemas"]["webhooks_answer"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "unanswered";
+ discussion: components["schemas"]["discussion"];
+ old_answer: components["schemas"]["webhooks_answer"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** discussion unlabeled event */
- readonly "webhook-discussion-unlabeled": {
+ "webhook-discussion-unlabeled": {
/** @enum {string} */
- readonly action: "unlabeled";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unlabeled";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion unlocked event */
- readonly "webhook-discussion-unlocked": {
+ "webhook-discussion-unlocked": {
/** @enum {string} */
- readonly action: "unlocked";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unlocked";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** discussion unpinned event */
- readonly "webhook-discussion-unpinned": {
+ "webhook-discussion-unpinned": {
/** @enum {string} */
- readonly action: "unpinned";
- readonly discussion: components["schemas"]["discussion"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unpinned";
+ discussion: components["schemas"]["discussion"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/**
* fork event
* @description A user forks a repository.
*/
- readonly "webhook-fork": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ "webhook-fork": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
/** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */
- readonly forkee: {
+ forkee: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} & {
- readonly allow_forking?: boolean;
- readonly archive_url?: string;
- readonly archived?: boolean;
- readonly assignees_url?: string;
- readonly blobs_url?: string;
- readonly branches_url?: string;
- readonly clone_url?: string;
- readonly collaborators_url?: string;
- readonly comments_url?: string;
- readonly commits_url?: string;
- readonly compare_url?: string;
- readonly contents_url?: string;
- readonly contributors_url?: string;
- readonly created_at?: string;
- readonly default_branch?: string;
- readonly deployments_url?: string;
- readonly description?: string | null;
- readonly disabled?: boolean;
- readonly downloads_url?: string;
- readonly events_url?: string;
+ allow_forking?: boolean;
+ archive_url?: string;
+ archived?: boolean;
+ assignees_url?: string;
+ blobs_url?: string;
+ branches_url?: string;
+ clone_url?: string;
+ collaborators_url?: string;
+ comments_url?: string;
+ commits_url?: string;
+ compare_url?: string;
+ contents_url?: string;
+ contributors_url?: string;
+ created_at?: string;
+ default_branch?: string;
+ deployments_url?: string;
+ description?: string | null;
+ disabled?: boolean;
+ downloads_url?: string;
+ events_url?: string;
/** @enum {boolean} */
- readonly fork?: true;
- readonly forks?: number;
- readonly forks_count?: number;
- readonly forks_url?: string;
- readonly full_name?: string;
- readonly git_commits_url?: string;
- readonly git_refs_url?: string;
- readonly git_tags_url?: string;
- readonly git_url?: string;
- readonly has_downloads?: boolean;
- readonly has_issues?: boolean;
- readonly has_pages?: boolean;
- readonly has_projects?: boolean;
- readonly has_wiki?: boolean;
- readonly homepage?: string | null;
- readonly hooks_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly is_template?: boolean;
- readonly issue_comment_url?: string;
- readonly issue_events_url?: string;
- readonly issues_url?: string;
- readonly keys_url?: string;
- readonly labels_url?: string;
- readonly language?: unknown;
- readonly languages_url?: string;
- readonly license?: Record | null;
- readonly merges_url?: string;
- readonly milestones_url?: string;
- readonly mirror_url?: unknown;
- readonly name?: string;
- readonly node_id?: string;
- readonly notifications_url?: string;
- readonly open_issues?: number;
- readonly open_issues_count?: number;
- readonly owner?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- readonly private?: boolean;
- readonly public?: boolean;
- readonly pulls_url?: string;
- readonly pushed_at?: string;
- readonly releases_url?: string;
- readonly size?: number;
- readonly ssh_url?: string;
- readonly stargazers_count?: number;
- readonly stargazers_url?: string;
- readonly statuses_url?: string;
- readonly subscribers_url?: string;
- readonly subscription_url?: string;
- readonly svn_url?: string;
- readonly tags_url?: string;
- readonly teams_url?: string;
- readonly topics?: readonly unknown[];
- readonly trees_url?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly visibility?: string;
- readonly watchers?: number;
- readonly watchers_count?: number;
- };
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ fork?: true;
+ forks?: number;
+ forks_count?: number;
+ forks_url?: string;
+ full_name?: string;
+ git_commits_url?: string;
+ git_refs_url?: string;
+ git_tags_url?: string;
+ git_url?: string;
+ has_downloads?: boolean;
+ has_issues?: boolean;
+ has_pages?: boolean;
+ has_projects?: boolean;
+ has_wiki?: boolean;
+ homepage?: string | null;
+ hooks_url?: string;
+ html_url?: string;
+ id?: number;
+ is_template?: boolean;
+ issue_comment_url?: string;
+ issue_events_url?: string;
+ issues_url?: string;
+ keys_url?: string;
+ labels_url?: string;
+ language?: unknown;
+ languages_url?: string;
+ license?: Record | null;
+ merges_url?: string;
+ milestones_url?: string;
+ mirror_url?: unknown;
+ name?: string;
+ node_id?: string;
+ notifications_url?: string;
+ open_issues?: number;
+ open_issues_count?: number;
+ owner?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ private?: boolean;
+ public?: boolean;
+ pulls_url?: string;
+ pushed_at?: string;
+ releases_url?: string;
+ size?: number;
+ ssh_url?: string;
+ stargazers_count?: number;
+ stargazers_url?: string;
+ statuses_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ svn_url?: string;
+ tags_url?: string;
+ teams_url?: string;
+ topics?: unknown[];
+ trees_url?: string;
+ updated_at?: string;
+ url?: string;
+ visibility?: string;
+ watchers?: number;
+ watchers_count?: number;
+ };
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** github_app_authorization revoked event */
- readonly "webhook-github-app-authorization-revoked": {
+ "webhook-github-app-authorization-revoked": {
/** @enum {string} */
- readonly action: "revoked";
- readonly sender: components["schemas"]["simple-user"];
+ action: "revoked";
+ sender: components["schemas"]["simple-user"];
};
/** gollum event */
- readonly "webhook-gollum": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ "webhook-gollum": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description The pages that were updated. */
- readonly pages: readonly {
+ pages: {
/**
* @description The action that was performed on the page. Can be `created` or `edited`.
* @enum {string}
*/
- readonly action: "created" | "edited";
+ action: "created" | "edited";
/**
* Format: uri
* @description Points to the HTML wiki page.
*/
- readonly html_url: string;
+ html_url: string;
/** @description The name of the page. */
- readonly page_name: string;
+ page_name: string;
/** @description The latest commit SHA of the page. */
- readonly sha: string;
- readonly summary: string | null;
+ sha: string;
+ summary: string | null;
/** @description The current page title. */
- readonly title: string;
+ title: string;
}[];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** installation created event */
- readonly "webhook-installation-created": {
+ "webhook-installation-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories?: components["schemas"]["webhooks_repositories"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: components["schemas"]["webhooks_user"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories?: components["schemas"]["webhooks_repositories"];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: components["schemas"]["webhooks_user"];
+ sender: components["schemas"]["simple-user"];
};
/** installation deleted event */
- readonly "webhook-installation-deleted": {
+ "webhook-installation-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories?: components["schemas"]["webhooks_repositories"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories?: components["schemas"]["webhooks_repositories"];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user"];
};
/** installation new_permissions_accepted event */
- readonly "webhook-installation-new-permissions-accepted": {
+ "webhook-installation-new-permissions-accepted": {
/** @enum {string} */
- readonly action: "new_permissions_accepted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories?: components["schemas"]["webhooks_repositories"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user"];
+ action: "new_permissions_accepted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories?: components["schemas"]["webhooks_repositories"];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user"];
};
/** installation_repositories added event */
- readonly "webhook-installation-repositories-added": {
+ "webhook-installation-repositories-added": {
/** @enum {string} */
- readonly action: "added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ action: "added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories_added: components["schemas"]["webhooks_repositories_added"];
/** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: readonly {
- readonly full_name?: string;
+ repositories_removed: {
+ full_name?: string;
/** @description Unique identifier of the repository */
- readonly id?: number;
+ id?: number;
/** @description The name of the repository. */
- readonly name?: string;
- readonly node_id?: string;
+ name?: string;
+ node_id?: string;
/** @description Whether the repository is private or public. */
- readonly private?: boolean;
+ private?: boolean;
}[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
- readonly requester: components["schemas"]["webhooks_user"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_selection: components["schemas"]["webhooks_repository_selection"];
+ requester: components["schemas"]["webhooks_user"];
+ sender: components["schemas"]["simple-user"];
};
/** installation_repositories removed event */
- readonly "webhook-installation-repositories-removed": {
+ "webhook-installation-repositories-removed": {
/** @enum {string} */
- readonly action: "removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories_added: components["schemas"]["webhooks_repositories_added"];
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories_added: components["schemas"]["webhooks_repositories_added"];
/** @description An array of repository objects, which were removed from the installation. */
- readonly repositories_removed: readonly {
- readonly full_name: string;
+ repositories_removed: {
+ full_name: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
}[];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_selection: components["schemas"]["webhooks_repository_selection"];
- readonly requester: components["schemas"]["webhooks_user"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_selection: components["schemas"]["webhooks_repository_selection"];
+ requester: components["schemas"]["webhooks_user"];
+ sender: components["schemas"]["simple-user"];
};
/** installation suspend event */
- readonly "webhook-installation-suspend": {
+ "webhook-installation-suspend": {
/** @enum {string} */
- readonly action: "suspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories?: components["schemas"]["webhooks_repositories"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user"];
- };
- readonly "webhook-installation-target-renamed": {
- readonly account: {
- readonly archived_at?: string | null;
- readonly avatar_url: string;
- readonly created_at?: string;
- readonly description?: unknown;
- readonly events_url?: string;
- readonly followers?: number;
- readonly followers_url?: string;
- readonly following?: number;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly has_organization_projects?: boolean;
- readonly has_repository_projects?: boolean;
- readonly hooks_url?: string;
- readonly html_url: string;
- readonly id: number;
- readonly is_verified?: boolean;
- readonly issues_url?: string;
- readonly login?: string;
- readonly members_url?: string;
- readonly name?: string;
- readonly node_id: string;
- readonly organizations_url?: string;
- readonly public_gists?: number;
- readonly public_members_url?: string;
- readonly public_repos?: number;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly slug?: string;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly website_url?: unknown;
- readonly user_view_type?: string;
+ action: "suspend";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories?: components["schemas"]["webhooks_repositories"];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user"];
+ };
+ "webhook-installation-target-renamed": {
+ account: {
+ archived_at?: string | null;
+ avatar_url: string;
+ created_at?: string;
+ description?: unknown;
+ events_url?: string;
+ followers?: number;
+ followers_url?: string;
+ following?: number;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ has_organization_projects?: boolean;
+ has_repository_projects?: boolean;
+ hooks_url?: string;
+ html_url: string;
+ id: number;
+ is_verified?: boolean;
+ issues_url?: string;
+ login?: string;
+ members_url?: string;
+ name?: string;
+ node_id: string;
+ organizations_url?: string;
+ public_gists?: number;
+ public_members_url?: string;
+ public_repos?: number;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ slug?: string;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ updated_at?: string;
+ url?: string;
+ website_url?: unknown;
+ user_view_type?: string;
};
/** @enum {string} */
- readonly action: "renamed";
- readonly changes: {
- readonly login?: {
- readonly from: string;
+ action: "renamed";
+ changes: {
+ login?: {
+ from: string;
};
- readonly slug?: {
- readonly from: string;
+ slug?: {
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
- readonly target_type: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ target_type: string;
};
/** installation unsuspend event */
- readonly "webhook-installation-unsuspend": {
+ "webhook-installation-unsuspend": {
/** @enum {string} */
- readonly action: "unsuspend";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repositories?: components["schemas"]["webhooks_repositories"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly requester?: unknown;
- readonly sender: components["schemas"]["simple-user"];
+ action: "unsuspend";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repositories?: components["schemas"]["webhooks_repositories"];
+ repository?: components["schemas"]["repository-webhooks"];
+ requester?: unknown;
+ sender: components["schemas"]["simple-user"];
};
/** issue_comment created event */
- readonly "webhook-issue-comment-created": {
+ "webhook-issue-comment-created": {
/** @enum {string} */
- readonly action: "created";
+ action: "created";
/**
* issue comment
* @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself.
*/
- readonly comment: {
+ comment: {
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue comment */
- readonly body: string;
+ body: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the issue comment
*/
- readonly id: number;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly node_id: string;
- readonly performed_via_github_app: components["schemas"]["nullable-integration"];
+ issue_url: string;
+ node_id: string;
+ performed_via_github_app: components["schemas"]["nullable-integration"];
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue comment
*/
- readonly url: string;
+ url: string;
+ pin?: components["schemas"]["nullable-pinned-issue-comment"];
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
+ repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
} & {
- readonly active_lock_reason?: string | null;
+ active_lock_reason?: string | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees?: readonly (Record | null)[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: readonly {
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record | null;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
+ labels_url?: string;
+ locked: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issue_comment deleted event */
- readonly "webhook-issue-comment-deleted": {
+ "webhook-issue-comment-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly comment: components["schemas"]["webhooks_issue_comment"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "deleted";
+ comment: components["schemas"]["webhooks_issue_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
} & {
- readonly active_lock_reason?: string | null;
+ active_lock_reason?: string | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees?: readonly (Record | null)[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: readonly {
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record | null;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
+ labels_url?: string;
+ locked: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issue_comment edited event */
- readonly "webhook-issue-comment-edited": {
+ "webhook-issue-comment-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: components["schemas"]["webhooks_changes"];
- readonly comment: components["schemas"]["webhooks_issue_comment"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "edited";
+ changes: components["schemas"]["webhooks_changes"];
+ comment: components["schemas"]["webhooks_issue_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "pull_request_review_thread")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
} & {
- readonly active_lock_reason?: string | null;
+ active_lock_reason?: string | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees?: readonly (Record | null)[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at?: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels: readonly {
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly labels_url?: string;
- readonly locked: boolean;
- readonly milestone?: Record | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record | null;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
+ labels_url?: string;
+ locked: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- };
- /** issues assigned event */
- readonly "webhook-issues-assigned": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "assigned";
- readonly assignee?: components["schemas"]["webhooks_user"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- };
- /** issues closed event */
- readonly "webhook-issues-closed": {
- /**
- * @description The action that was performed.
- * @enum {string}
- */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
- readonly issue: {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issue_comment pinned event */
+ "webhook-issue-comment-pinned": {
+ /** @enum {string} */
+ action: "pinned";
+ comment: components["schemas"]["webhooks_issue_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ team_discussions?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
} & {
- readonly active_lock_reason?: string | null;
- readonly assignee?: Record | null;
- readonly assignees?: readonly (Record | null)[];
- readonly author_association?: string;
- readonly body?: string | null;
- readonly closed_at: string | null;
- readonly comments?: number;
- readonly comments_url?: string;
- readonly created_at?: string;
- readonly events_url?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: readonly (Record | null)[];
- readonly labels_url?: string;
- readonly locked?: boolean;
- readonly milestone?: Record | null;
- readonly node_id?: string;
- readonly number?: number;
- readonly performed_via_github_app?: Record | null;
- readonly reactions?: {
- readonly "+1"?: number;
- readonly "-1"?: number;
- readonly confused?: number;
- readonly eyes?: number;
- readonly heart?: number;
- readonly hooray?: number;
- readonly laugh?: number;
- readonly rocket?: number;
- readonly total_count?: number;
- readonly url?: string;
- };
- readonly repository_url?: string;
- /** @enum {string} */
- readonly state: "closed" | "open";
- readonly timeline_url?: string;
- readonly title?: string;
- readonly updated_at?: string;
- readonly url?: string;
- readonly user?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
+ active_lock_reason?: string | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ labels_url?: string;
+ locked: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
- };
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- };
- /** issues deleted event */
- readonly "webhook-issues-deleted": {
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issue_comment unpinned event */
+ "webhook-issue-comment-unpinned": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- /**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
- */
- readonly issue: {
+ action: "unpinned";
+ comment: components["schemas"]["webhooks_issue_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. */
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ team_discussions?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- };
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- };
- /** issues demilestoned event */
- readonly "webhook-issues-demilestoned": {
+ } & {
+ active_lock_reason?: string | null;
+ /** User */
+ assignee: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at?: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ labels_url?: string;
+ locked: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ /** Format: int64 */
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** blocked by issue added event */
+ "webhook-issue-dependencies-blocked-by-added": {
+ /** @enum {string} */
+ action: "blocked_by_added";
+ /** @description The ID of the blocked issue. */
+ blocked_issue_id?: number;
+ blocked_issue?: components["schemas"]["issue"];
+ /** @description The ID of the blocking issue. */
+ blocking_issue_id?: number;
+ blocking_issue?: components["schemas"]["issue"];
+ blocking_issue_repo?: components["schemas"]["repository"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** blocked by issue removed event */
+ "webhook-issue-dependencies-blocked-by-removed": {
+ /** @enum {string} */
+ action: "blocked_by_removed";
+ /** @description The ID of the blocked issue. */
+ blocked_issue_id?: number;
+ blocked_issue?: components["schemas"]["issue"];
+ /** @description The ID of the blocking issue. */
+ blocking_issue_id?: number;
+ blocking_issue?: components["schemas"]["issue"];
+ blocking_issue_repo?: components["schemas"]["repository"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** blocking issue added event */
+ "webhook-issue-dependencies-blocking-added": {
/** @enum {string} */
- readonly action: "demilestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "blocking_added";
+ /** @description The ID of the blocked issue. */
+ blocked_issue_id?: number;
+ blocked_issue?: components["schemas"]["issue"];
+ blocked_issue_repo?: components["schemas"]["repository"];
+ /** @description The ID of the blocking issue. */
+ blocking_issue_id?: number;
+ blocking_issue?: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** blocking issue removed event */
+ "webhook-issue-dependencies-blocking-removed": {
+ /** @enum {string} */
+ action: "blocking_removed";
+ /** @description The ID of the blocked issue. */
+ blocked_issue_id?: number;
+ blocked_issue?: components["schemas"]["issue"];
+ blocked_issue_repo?: components["schemas"]["repository"];
+ /** @description The ID of the blocking issue. */
+ blocking_issue_id?: number;
+ blocking_issue?: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues assigned event */
+ "webhook-issues-assigned": {
/**
- * Issue
- * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ * @description The action that was performed.
+ * @enum {string}
*/
- readonly issue: {
+ action: "assigned";
+ assignee?: components["schemas"]["webhooks_user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues closed event */
+ "webhook-issues-closed": {
+ /**
+ * @description The action that was performed.
+ * @enum {string}
+ */
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /** @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly ({
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
- } | null)[];
+ url: string;
+ }[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- };
- readonly milestone?: components["schemas"]["webhooks_milestone"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ } & {
+ active_lock_reason?: string | null;
+ assignee?: Record | null;
+ assignees?: (Record | null)[];
+ author_association?: string;
+ body?: string | null;
+ closed_at: string | null;
+ comments?: number;
+ comments_url?: string;
+ created_at?: string;
+ events_url?: string;
+ html_url?: string;
+ id?: number;
+ labels?: (Record | null)[];
+ labels_url?: string;
+ locked?: boolean;
+ milestone?: Record | null;
+ node_id?: string;
+ number?: number;
+ performed_via_github_app?: Record | null;
+ reactions?: {
+ "+1"?: number;
+ "-1"?: number;
+ confused?: number;
+ eyes?: number;
+ heart?: number;
+ hooray?: number;
+ laugh?: number;
+ rocket?: number;
+ total_count?: number;
+ url?: string;
+ };
+ repository_url?: string;
+ /** @enum {string} */
+ state: "closed" | "open";
+ timeline_url?: string;
+ title?: string;
+ updated_at?: string;
+ url?: string;
+ user?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ /** Format: int64 */
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
+ };
+ };
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
- /** issues edited event */
- readonly "webhook-issues-edited": {
+ /** issues deleted event */
+ "webhook-issues-deleted": {
/** @enum {string} */
- readonly action: "edited";
- /** @description The changes to the issue. */
- readonly changes: {
- readonly body?: {
- /** @description The previous version of the body. */
- readonly from: string;
- };
- readonly title?: {
- /** @description The previous version of the title. */
- readonly from: string;
- };
- };
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
- /** @enum {string} */
- readonly actions?: "read" | "write";
+ permissions?: {
/** @enum {string} */
- readonly administration?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly label?: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
- /** issues labeled event */
- readonly "webhook-issues-labeled": {
+ /** issues demilestoned event */
+ "webhook-issues-demilestoned": {
/** @enum {string} */
- readonly action: "labeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "demilestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: ({
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
- }[];
+ url: string;
+ } | null)[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly actions?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
+ };
+ /** 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;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ /** @description Title of the issue */
+ title: string;
+ type?: components["schemas"]["issue-type"];
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: 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;
+ /** Format: int64 */
+ 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ };
+ milestone?: components["schemas"]["webhooks_milestone"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues edited event */
+ "webhook-issues-edited": {
+ /** @enum {string} */
+ action: "edited";
+ /** @description The changes to the issue. */
+ changes: {
+ body?: {
+ /** @description The previous version of the body. */
+ from: string;
+ };
+ title?: {
+ /** @description The previous version of the title. */
+ from: string;
+ };
+ };
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ 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";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
+ /** Format: uri */
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: string;
+ /** User */
+ owner: {
+ /** 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;
+ user_view_type?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly workflows?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
+ /**
+ * @description State of the issue; either 'open' or 'closed'
+ * @enum {string}
+ */
+ state?: "open" | "closed";
+ state_reason?: string | null;
+ /** Format: uri */
+ timeline_url?: string;
+ type?: components["schemas"]["issue-type"];
+ /** @description Title of the issue */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /**
+ * Format: uri
+ * @description URL for the issue
+ */
+ url: string;
+ /** User */
+ user: {
/** Format: uri */
- readonly url: string;
- };
+ 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;
+ /** Format: int64 */
+ 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ };
+ label?: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues labeled event */
+ "webhook-issues-labeled": {
+ /** @enum {string} */
+ action: "labeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ /**
+ * Issue
+ * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
+ */
+ issue: {
+ /** @enum {string|null} */
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ /** User */
+ assignee?: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ assignees: ({
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ 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";
+ /** @description Contents of the issue */
+ body: string | null;
+ /** Format: date-time */
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
+ comments_url: string;
+ /** Format: date-time */
+ created_at: string;
+ draft?: boolean;
+ /** Format: uri */
+ events_url: string;
+ /** Format: uri */
+ html_url: string;
+ /** Format: int64 */
+ id: number;
+ labels?: {
+ /** @description 6-character hex code, without the leading #, identifying the color */
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
+ /** @description The name of the label. */
+ name: string;
+ node_id: string;
+ /**
+ * Format: uri
+ * @description URL for the label
+ */
+ url: string;
+ }[];
+ /** Format: uri-template */
+ labels_url: string;
+ locked?: boolean;
+ /**
+ * Milestone
+ * @description A collection of related issues and pull requests.
+ */
+ milestone: {
+ /** Format: date-time */
+ closed_at: string | null;
+ closed_issues: number;
+ /** Format: date-time */
+ created_at: string;
+ /** User */
+ creator: {
+ /** 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" | "Mannequin";
+ /** Format: uri */
+ url?: string;
+ user_view_type?: string;
+ } | null;
+ description: string | null;
+ /** Format: date-time */
+ due_on: string | null;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** Format: uri */
+ labels_url: string;
+ node_id: string;
+ /** @description The number of the milestone. */
+ number: number;
+ open_issues: number;
+ /**
+ * @description The state of the milestone.
+ * @enum {string}
+ */
+ state: "open" | "closed";
+ /** @description The title of the milestone. */
+ title: string;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ } | null;
+ node_id: string;
+ number: number;
+ /**
+ * App
+ * @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
+ */
+ performed_via_github_app?: {
+ /** Format: date-time */
+ created_at: string | null;
+ description: string | null;
+ /** @description The list of events for the GitHub app */
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
+ /** Format: uri */
+ external_url: string | null;
+ /** Format: uri */
+ html_url: string;
+ /** @description Unique identifier of the GitHub app */
+ id: number | null;
+ /** @description The name of the GitHub app */
+ name: string;
+ node_id: string;
+ /** User */
+ owner: {
+ /** 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;
+ user_view_type?: string;
+ } | null;
+ /** @description The set of permissions for the GitHub app */
+ permissions?: {
+ /** @enum {string} */
+ actions?: "read" | "write";
+ /** @enum {string} */
+ administration?: "read" | "write";
+ /** @enum {string} */
+ checks?: "read" | "write";
+ /** @enum {string} */
+ content_references?: "read" | "write";
+ /** @enum {string} */
+ contents?: "read" | "write";
+ /** @enum {string} */
+ deployments?: "read" | "write";
+ /** @enum {string} */
+ discussions?: "read" | "write";
+ /** @enum {string} */
+ emails?: "read" | "write";
+ /** @enum {string} */
+ environments?: "read" | "write";
+ /** @enum {string} */
+ issues?: "read" | "write";
+ /** @enum {string} */
+ keys?: "read" | "write";
+ /** @enum {string} */
+ members?: "read" | "write";
+ /** @enum {string} */
+ metadata?: "read" | "write";
+ /** @enum {string} */
+ organization_administration?: "read" | "write";
+ /** @enum {string} */
+ organization_hooks?: "read" | "write";
+ /** @enum {string} */
+ organization_packages?: "read" | "write";
+ /** @enum {string} */
+ organization_plan?: "read" | "write";
+ /** @enum {string} */
+ organization_projects?: "read" | "write" | "admin";
+ /** @enum {string} */
+ organization_secrets?: "read" | "write";
+ /** @enum {string} */
+ organization_self_hosted_runners?: "read" | "write";
+ /** @enum {string} */
+ organization_user_blocking?: "read" | "write";
+ /** @enum {string} */
+ packages?: "read" | "write";
+ /** @enum {string} */
+ pages?: "read" | "write";
+ /** @enum {string} */
+ pull_requests?: "read" | "write";
+ /** @enum {string} */
+ repository_hooks?: "read" | "write";
+ /** @enum {string} */
+ repository_projects?: "read" | "write";
+ /** @enum {string} */
+ secret_scanning_alerts?: "read" | "write";
+ /** @enum {string} */
+ secrets?: "read" | "write";
+ /** @enum {string} */
+ security_events?: "read" | "write";
+ /** @enum {string} */
+ security_scanning_alert?: "read" | "write";
+ /** @enum {string} */
+ single_file?: "read" | "write";
+ /** @enum {string} */
+ statuses?: "read" | "write";
+ /** @enum {string} */
+ vulnerability_alerts?: "read" | "write";
+ /** @enum {string} */
+ workflows?: "read" | "write";
+ };
+ /** @description The slug name of the GitHub app */
+ slug?: string;
+ /** Format: date-time */
+ updated_at: string | null;
+ } | null;
+ pull_request?: {
+ /** Format: uri */
+ diff_url?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: date-time */
+ merged_at?: string | null;
+ /** Format: uri */
+ patch_url?: string;
+ /** Format: uri */
+ url?: string;
};
+ /** 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;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
+ type?: components["schemas"]["issue-type"];
/** @description Title of the issue */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly label?: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ label?: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues locked event */
- readonly "webhook-issues-locked": {
+ "webhook-issues-locked": {
/** @enum {string} */
- readonly action: "locked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "locked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly ({
+ id: number;
+ labels?: ({
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** @enum {boolean} */
- readonly locked: true;
+ locked: true;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder" | "security_and_analysis")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
+ type?: components["schemas"]["issue-type"];
/** @description Title of the issue */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues milestoned event */
- readonly "webhook-issues-milestoned": {
+ "webhook-issues-milestoned": {
/** @enum {string} */
- readonly action: "milestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "milestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly ({
+ id: number;
+ labels?: ({
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "reminder")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly milestone: components["schemas"]["webhooks_milestone"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ milestone: components["schemas"]["webhooks_milestone"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues opened event */
- readonly "webhook-issues-opened": {
+ "webhook-issues-opened": {
/** @enum {string} */
- readonly action: "opened";
- readonly changes?: {
+ action: "opened";
+ changes?: {
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly old_issue: {
+ old_issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason?: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees?: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association?: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body?: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at?: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url?: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at?: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url?: string;
/** Format: uri */
- readonly html_url: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url?: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone?: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id?: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ repository_url?: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title?: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at?: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url?: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
/** User */
- readonly user: {
+ user?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
+ type?: components["schemas"]["issue-type"];
} | null;
/**
* Repository
* @description A git repository
*/
- readonly old_repository: {
+ old_repository: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/** @description Whether the repository has discussions enabled. */
- readonly has_discussions?: boolean;
+ has_discussions?: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require commit signoff. */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "security_and_analysis" | "pull_request_review_thread" | "reminder")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues pinned event */
- readonly "webhook-issues-pinned": {
+ "webhook-issues-pinned": {
/** @enum {string} */
- readonly action: "pinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue_2"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "pinned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue_2"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues reopened event */
- readonly "webhook-issues-reopened": {
+ "webhook-issues-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly ({
+ id: number;
+ labels?: ({
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run" | "pull_request_review_thread" | "reminder")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write" | "admin";
+ organization_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write" | "admin";
+ repository_projects?: "read" | "write" | "admin";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state: "open" | "closed";
- readonly state_reason?: string | null;
+ state: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
+ type?: components["schemas"]["issue-type"];
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues transferred event */
- readonly "webhook-issues-transferred": {
+ "webhook-issues-transferred": {
/** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
+ action: "transferred";
+ changes: {
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly new_issue: {
+ new_issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly {
+ id: number;
+ labels?: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly labels_url: string;
- readonly locked?: boolean;
+ labels_url: string;
+ locked?: boolean;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/**
* Repository
* @description A git repository
*/
- readonly new_repository: {
+ new_repository: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue_2"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue_2"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues typed event */
+ "webhook-issues-typed": {
+ /** @enum {string} */
+ action: "typed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue"];
+ type: components["schemas"]["issue-type"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues unassigned event */
- readonly "webhook-issues-unassigned": {
+ "webhook-issues-unassigned": {
/**
* @description The action that was performed.
* @enum {string}
*/
- readonly action: "unassigned";
- readonly assignee?: components["schemas"]["webhooks_user_mannequin"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unassigned";
+ assignee?: components["schemas"]["webhooks_user_mannequin"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues unlabeled event */
- readonly "webhook-issues-unlabeled": {
+ "webhook-issues-unlabeled": {
/** @enum {string} */
- readonly action: "unlabeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue"];
- readonly label?: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unlabeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue"];
+ label?: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues unlocked event */
- readonly "webhook-issues-unlocked": {
+ "webhook-issues-unlocked": {
/** @enum {string} */
- readonly action: "unlocked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "unlocked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/**
* Issue
* @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself.
*/
- readonly issue: {
+ issue: {
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee?: {
+ assignee?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description Contents of the issue */
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments: number;
+ closed_at: string | null;
+ comments: number;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly draft?: boolean;
+ created_at: string;
+ draft?: boolean;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** Format: int64 */
- readonly id: number;
- readonly labels?: readonly ({
+ id: number;
+ labels?: ({
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** @enum {boolean} */
- readonly locked: false;
+ locked: false;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/**
* App
* @description GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
*/
- readonly performed_via_github_app?: {
+ performed_via_github_app?: {
/** Format: date-time */
- readonly created_at: string | null;
- readonly description: string | null;
+ created_at: string | null;
+ description: string | null;
/** @description The list of events for the GitHub app */
- readonly events?: readonly ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
+ events?: ("branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "content_reference" | "create" | "delete" | "deployment" | "deployment_review" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "milestone" | "organization" | "org_block" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "push" | "registry_package" | "release" | "repository" | "repository_dispatch" | "secret_scanning_alert" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_dispatch" | "workflow_run")[];
/** Format: uri */
- readonly external_url: string | null;
+ external_url: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the GitHub app */
- readonly id: number | null;
+ id: number | null;
/** @description The name of the GitHub app */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The set of permissions for the GitHub app */
- readonly permissions?: {
+ permissions?: {
/** @enum {string} */
- readonly actions?: "read" | "write";
+ actions?: "read" | "write";
/** @enum {string} */
- readonly administration?: "read" | "write";
+ administration?: "read" | "write";
/** @enum {string} */
- readonly checks?: "read" | "write";
+ checks?: "read" | "write";
/** @enum {string} */
- readonly content_references?: "read" | "write";
+ content_references?: "read" | "write";
/** @enum {string} */
- readonly contents?: "read" | "write";
+ contents?: "read" | "write";
/** @enum {string} */
- readonly deployments?: "read" | "write";
+ deployments?: "read" | "write";
/** @enum {string} */
- readonly discussions?: "read" | "write";
+ discussions?: "read" | "write";
/** @enum {string} */
- readonly emails?: "read" | "write";
+ emails?: "read" | "write";
/** @enum {string} */
- readonly environments?: "read" | "write";
+ environments?: "read" | "write";
/** @enum {string} */
- readonly issues?: "read" | "write";
+ issues?: "read" | "write";
/** @enum {string} */
- readonly keys?: "read" | "write";
+ keys?: "read" | "write";
/** @enum {string} */
- readonly members?: "read" | "write";
+ members?: "read" | "write";
/** @enum {string} */
- readonly metadata?: "read" | "write";
+ metadata?: "read" | "write";
/** @enum {string} */
- readonly organization_administration?: "read" | "write";
+ organization_administration?: "read" | "write";
/** @enum {string} */
- readonly organization_hooks?: "read" | "write";
+ organization_hooks?: "read" | "write";
/** @enum {string} */
- readonly organization_packages?: "read" | "write";
+ organization_packages?: "read" | "write";
/** @enum {string} */
- readonly organization_plan?: "read" | "write";
+ organization_plan?: "read" | "write";
/** @enum {string} */
- readonly organization_projects?: "read" | "write";
+ organization_projects?: "read" | "write";
/** @enum {string} */
- readonly organization_secrets?: "read" | "write";
+ organization_secrets?: "read" | "write";
/** @enum {string} */
- readonly organization_self_hosted_runners?: "read" | "write";
+ organization_self_hosted_runners?: "read" | "write";
/** @enum {string} */
- readonly organization_user_blocking?: "read" | "write";
+ organization_user_blocking?: "read" | "write";
/** @enum {string} */
- readonly packages?: "read" | "write";
+ packages?: "read" | "write";
/** @enum {string} */
- readonly pages?: "read" | "write";
+ pages?: "read" | "write";
/** @enum {string} */
- readonly pull_requests?: "read" | "write";
+ pull_requests?: "read" | "write";
/** @enum {string} */
- readonly repository_hooks?: "read" | "write";
+ repository_hooks?: "read" | "write";
/** @enum {string} */
- readonly repository_projects?: "read" | "write";
+ repository_projects?: "read" | "write";
/** @enum {string} */
- readonly secret_scanning_alerts?: "read" | "write";
+ secret_scanning_alerts?: "read" | "write";
/** @enum {string} */
- readonly secrets?: "read" | "write";
+ secrets?: "read" | "write";
/** @enum {string} */
- readonly security_events?: "read" | "write";
+ security_events?: "read" | "write";
/** @enum {string} */
- readonly security_scanning_alert?: "read" | "write";
+ security_scanning_alert?: "read" | "write";
/** @enum {string} */
- readonly single_file?: "read" | "write";
+ single_file?: "read" | "write";
/** @enum {string} */
- readonly statuses?: "read" | "write";
+ statuses?: "read" | "write";
/** @enum {string} */
- readonly team_discussions?: "read" | "write";
+ vulnerability_alerts?: "read" | "write";
/** @enum {string} */
- readonly vulnerability_alerts?: "read" | "write";
- /** @enum {string} */
- readonly workflows?: "read" | "write";
+ workflows?: "read" | "write";
};
/** @description The slug name of the GitHub app */
- readonly slug?: string;
+ slug?: string;
/** Format: date-time */
- readonly updated_at: string | null;
+ updated_at: string | null;
} | null;
- readonly pull_request?: {
+ pull_request?: {
/** Format: uri */
- readonly diff_url?: string;
+ diff_url?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: date-time */
- readonly merged_at?: string | null;
+ merged_at?: string | null;
/** Format: uri */
- readonly patch_url?: string;
+ patch_url?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
- };
- /** Format: uri */
- readonly repository_url: string;
- /** Sub-issues Summary */
- readonly sub_issues_summary?: {
- readonly total: number;
- readonly completed: number;
- readonly percent_completed: number;
- };
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
+ };
+ /** Format: uri */
+ repository_url: string;
+ pinned_comment?: components["schemas"]["nullable-issue-comment"];
+ sub_issues_summary?: components["schemas"]["sub-issues-summary"];
+ issue_dependencies_summary?: components["schemas"]["issue-dependencies-summary"];
+ issue_field_values?: components["schemas"]["issue-field-value"][];
/**
* @description State of the issue; either 'open' or 'closed'
* @enum {string}
*/
- readonly state?: "open" | "closed";
- readonly state_reason?: string | null;
+ state?: "open" | "closed";
+ state_reason?: string | null;
/** Format: uri */
- readonly timeline_url?: string;
+ timeline_url?: string;
/** @description Title of the issue */
- readonly title: string;
+ title: string;
+ type?: components["schemas"]["issue-type"];
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the issue
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** issues unpinned event */
- readonly "webhook-issues-unpinned": {
+ "webhook-issues-unpinned": {
/** @enum {string} */
- readonly action: "unpinned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly issue: components["schemas"]["webhooks_issue_2"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unpinned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue_2"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** issues untyped event */
+ "webhook-issues-untyped": {
+ /** @enum {string} */
+ action: "untyped";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ issue: components["schemas"]["webhooks_issue"];
+ type: components["schemas"]["issue-type"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** label created event */
- readonly "webhook-label-created": {
+ "webhook-label-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** label deleted event */
- readonly "webhook-label-deleted": {
+ "webhook-label-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** label edited event */
- readonly "webhook-label-edited": {
+ "webhook-label-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the label if the action was `edited`. */
- readonly changes?: {
- readonly color?: {
+ changes?: {
+ color?: {
/** @description The previous version of the color if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly description?: {
+ description?: {
/** @description The previous version of the description if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly name?: {
+ name?: {
/** @description The previous version of the name if the action was `edited`. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label: components["schemas"]["webhooks_label"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label: components["schemas"]["webhooks_label"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** marketplace_purchase cancelled event */
- readonly "webhook-marketplace-purchase-cancelled": {
+ "webhook-marketplace-purchase-cancelled": {
/** @enum {string} */
- readonly action: "cancelled";
- readonly effective_date: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "cancelled";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** marketplace_purchase changed event */
- readonly "webhook-marketplace-purchase-changed": {
+ "webhook-marketplace-purchase-changed": {
/** @enum {string} */
- readonly action: "changed";
- readonly effective_date: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "changed";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean | null;
- readonly plan: {
- readonly bullets: readonly string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean | null;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
};
- readonly unit_count: number;
+ unit_count: number;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** marketplace_purchase pending_change event */
- readonly "webhook-marketplace-purchase-pending-change": {
+ "webhook-marketplace-purchase-pending-change": {
/** @enum {string} */
- readonly action: "pending_change";
- readonly effective_date: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "pending_change";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Marketplace Purchase */
- readonly previous_marketplace_purchase?: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: string | null;
- readonly next_billing_date?: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: readonly string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
+ previous_marketplace_purchase?: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: string | null;
+ next_billing_date?: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
};
- readonly unit_count: number;
+ unit_count: number;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** marketplace_purchase pending_change_cancelled event */
- readonly "webhook-marketplace-purchase-pending-change-cancelled": {
+ "webhook-marketplace-purchase-pending-change-cancelled": {
/** @enum {string} */
- readonly action: "pending_change_cancelled";
- readonly effective_date: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "pending_change_cancelled";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** Marketplace Purchase */
- readonly marketplace_purchase: {
- readonly account: {
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organization_billing_email: string | null;
- readonly type: string;
- };
- readonly billing_cycle: string;
- readonly free_trial_ends_on: unknown;
- readonly next_billing_date: string | null;
- readonly on_free_trial: boolean;
- readonly plan: {
- readonly bullets: readonly string[];
- readonly description: string;
- readonly has_free_trial: boolean;
- readonly id: number;
- readonly monthly_price_in_cents: number;
- readonly name: string;
+ marketplace_purchase: {
+ account: {
+ id: number;
+ login: string;
+ node_id: string;
+ organization_billing_email: string | null;
+ type: string;
+ };
+ billing_cycle: string;
+ free_trial_ends_on: unknown;
+ next_billing_date: string | null;
+ on_free_trial: boolean;
+ plan: {
+ bullets: string[];
+ description: string;
+ has_free_trial: boolean;
+ id: number;
+ monthly_price_in_cents: number;
+ name: string;
/** @enum {string} */
- readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
- readonly unit_name: string | null;
- readonly yearly_price_in_cents: number;
+ price_model: "FREE" | "FLAT_RATE" | "PER_UNIT";
+ unit_name: string | null;
+ yearly_price_in_cents: number;
};
- readonly unit_count: number;
+ unit_count: number;
};
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** marketplace_purchase purchased event */
- readonly "webhook-marketplace-purchase-purchased": {
+ "webhook-marketplace-purchase-purchased": {
/** @enum {string} */
- readonly action: "purchased";
- readonly effective_date: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "purchased";
+ effective_date: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** member added event */
- readonly "webhook-member-added": {
+ "webhook-member-added": {
/** @enum {string} */
- readonly action: "added";
- readonly changes?: {
+ action: "added";
+ changes?: {
/**
* @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain`
* role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role
* assigned to the collaborator, use the `role_name` field instead, which will provide the full
* role name, including custom roles.
*/
- readonly permission?: {
+ permission?: {
/** @enum {string} */
- readonly to: "write" | "admin" | "read";
+ to: "write" | "admin" | "read";
};
/** @description The role assigned to the collaborator. */
- readonly role_name?: {
- readonly to: string;
+ role_name?: {
+ to: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly member: components["schemas"]["webhooks_user"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ member: components["schemas"]["webhooks_user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** member edited event */
- readonly "webhook-member-edited": {
+ "webhook-member-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the collaborator permissions */
- readonly changes: {
- readonly old_permission?: {
+ changes: {
+ old_permission?: {
/** @description The previous permissions of the collaborator if the action was edited. */
- readonly from: string;
+ from: string;
};
- readonly permission?: {
- readonly from?: string | null;
- readonly to?: string | null;
+ permission?: {
+ from?: string | null;
+ to?: string | null;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly member: components["schemas"]["webhooks_user"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ member: components["schemas"]["webhooks_user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** member removed event */
- readonly "webhook-member-removed": {
+ "webhook-member-removed": {
/** @enum {string} */
- readonly action: "removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly member: components["schemas"]["webhooks_user"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ member: components["schemas"]["webhooks_user"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** membership added event */
- readonly "webhook-membership-added": {
+ "webhook-membership-added": {
/** @enum {string} */
- readonly action: "added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly member: components["schemas"]["webhooks_user"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ action: "added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ member: components["schemas"]["webhooks_user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
*/
- readonly scope: "team";
+ scope: "team";
/** User */
- readonly sender: {
+ sender: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly team: components["schemas"]["webhooks_team"];
+ team: components["schemas"]["webhooks_team"];
};
/** membership removed event */
- readonly "webhook-membership-removed": {
+ "webhook-membership-removed": {
/** @enum {string} */
- readonly action: "removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly member: components["schemas"]["webhooks_user"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ action: "removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ member: components["schemas"]["webhooks_user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/**
* @description The scope of the membership. Currently, can only be `team`.
* @enum {string}
*/
- readonly scope: "team" | "organization";
+ scope: "team" | "organization";
/** User */
- readonly sender: {
+ sender: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly team: components["schemas"]["webhooks_team"];
+ team: components["schemas"]["webhooks_team"];
};
- readonly "webhook-merge-group-checks-requested": {
+ "webhook-merge-group-checks-requested": {
/** @enum {string} */
- readonly action: "checks_requested";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
- };
- readonly "webhook-merge-group-destroyed": {
+ action: "checks_requested";
+ installation?: components["schemas"]["simple-installation"];
+ merge_group: components["schemas"]["merge-group"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ };
+ "webhook-merge-group-destroyed": {
/** @enum {string} */
- readonly action: "destroyed";
+ action: "destroyed";
/**
* @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).
* @enum {string}
*/
- readonly reason?: "merged" | "invalidated" | "dequeued";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly merge_group: components["schemas"]["merge-group"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ reason?: "merged" | "invalidated" | "dequeued";
+ installation?: components["schemas"]["simple-installation"];
+ merge_group: components["schemas"]["merge-group"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** meta deleted event */
- readonly "webhook-meta-deleted": {
+ "webhook-meta-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
- readonly hook: {
- readonly active: boolean;
- readonly config: {
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ /** @description The deleted webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */
+ hook: {
+ active: boolean;
+ config: {
/** @enum {string} */
- readonly content_type: "json" | "form";
- readonly insecure_ssl: string;
- readonly secret?: string;
+ content_type: "json" | "form";
+ insecure_ssl: string;
+ secret?: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly created_at: string;
- readonly events: readonly ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[];
- readonly id: number;
- readonly name: string;
- readonly type: string;
- readonly updated_at: string;
+ created_at: string;
+ events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[];
+ id: number;
+ name: string;
+ type: string;
+ updated_at: string;
};
/** @description The id of the modified webhook. */
- readonly hook_id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ hook_id: number;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** milestone closed event */
- readonly "webhook-milestone-closed": {
+ "webhook-milestone-closed": {
/** @enum {string} */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly milestone: components["schemas"]["webhooks_milestone"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ milestone: components["schemas"]["webhooks_milestone"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** milestone created event */
- readonly "webhook-milestone-created": {
+ "webhook-milestone-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly milestone: components["schemas"]["webhooks_milestone_3"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ milestone: components["schemas"]["webhooks_milestone_3"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** milestone deleted event */
- readonly "webhook-milestone-deleted": {
+ "webhook-milestone-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly milestone: components["schemas"]["webhooks_milestone"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ milestone: components["schemas"]["webhooks_milestone"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** milestone edited event */
- readonly "webhook-milestone-edited": {
+ "webhook-milestone-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the milestone if the action was `edited`. */
- readonly changes: {
- readonly description?: {
+ changes: {
+ description?: {
/** @description The previous version of the description if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly due_on?: {
+ due_on?: {
/** @description The previous version of the due date if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly title?: {
+ title?: {
/** @description The previous version of the title if the action was `edited`. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly milestone: components["schemas"]["webhooks_milestone"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ milestone: components["schemas"]["webhooks_milestone"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** milestone opened event */
- readonly "webhook-milestone-opened": {
+ "webhook-milestone-opened": {
/** @enum {string} */
- readonly action: "opened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly milestone: components["schemas"]["webhooks_milestone_3"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "opened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ milestone: components["schemas"]["webhooks_milestone_3"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** org_block blocked event */
- readonly "webhook-org-block-blocked": {
+ "webhook-org-block-blocked": {
/** @enum {string} */
- readonly action: "blocked";
- readonly blocked_user: components["schemas"]["webhooks_user"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "blocked";
+ blocked_user: components["schemas"]["webhooks_user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** org_block unblocked event */
- readonly "webhook-org-block-unblocked": {
+ "webhook-org-block-unblocked": {
/** @enum {string} */
- readonly action: "unblocked";
- readonly blocked_user: components["schemas"]["webhooks_user"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unblocked";
+ blocked_user: components["schemas"]["webhooks_user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** organization deleted event */
- readonly "webhook-organization-deleted": {
+ "webhook-organization-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly membership?: components["schemas"]["webhooks_membership"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ membership?: components["schemas"]["webhooks_membership"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** organization member_added event */
- readonly "webhook-organization-member-added": {
+ "webhook-organization-member-added": {
/** @enum {string} */
- readonly action: "member_added";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly membership: components["schemas"]["webhooks_membership"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "member_added";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ membership: components["schemas"]["webhooks_membership"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** organization member_invited event */
- readonly "webhook-organization-member-invited": {
+ "webhook-organization-member-invited": {
/** @enum {string} */
- readonly action: "member_invited";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "member_invited";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The invitation for the user or email if the action is `member_invited`. */
- readonly invitation: {
+ invitation: {
/** Format: date-time */
- readonly created_at: string;
- readonly email: string | null;
+ created_at: string;
+ email: string | null;
/** Format: date-time */
- readonly failed_at: string | null;
- readonly failed_reason: string | null;
- readonly id: number;
+ failed_at: string | null;
+ failed_reason: string | null;
+ id: number;
/** Format: uri */
- readonly invitation_teams_url: string;
+ invitation_teams_url: string;
/** User */
- readonly inviter: {
+ inviter: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly login: string | null;
- readonly node_id: string;
- readonly role: string;
- readonly team_count: number;
- readonly invitation_source?: string;
+ login: string | null;
+ node_id: string;
+ role: string;
+ team_count: number;
+ invitation_source?: string;
};
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly user?: components["schemas"]["webhooks_user"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ user?: components["schemas"]["webhooks_user"];
};
/** organization member_removed event */
- readonly "webhook-organization-member-removed": {
+ "webhook-organization-member-removed": {
/** @enum {string} */
- readonly action: "member_removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly membership: components["schemas"]["webhooks_membership"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "member_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ membership: components["schemas"]["webhooks_membership"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** organization renamed event */
- readonly "webhook-organization-renamed": {
+ "webhook-organization-renamed": {
/** @enum {string} */
- readonly action: "renamed";
- readonly changes?: {
- readonly login?: {
- readonly from?: string;
+ action: "renamed";
+ changes?: {
+ login?: {
+ from?: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly membership?: components["schemas"]["webhooks_membership"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ membership?: components["schemas"]["webhooks_membership"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Ruby Gems metadata */
- readonly "webhook-rubygems-metadata": {
- readonly name?: string;
- readonly description?: string;
- readonly readme?: string;
- readonly homepage?: string;
- readonly version_info?: {
- readonly version?: string;
- };
- readonly platform?: string;
- readonly metadata?: {
- readonly [key: string]: string;
- };
- readonly repo?: string;
- readonly dependencies?: readonly {
- readonly [key: string]: string;
+ "webhook-rubygems-metadata": {
+ name?: string;
+ description?: string;
+ readme?: string;
+ homepage?: string;
+ version_info?: {
+ version?: string;
+ };
+ platform?: string;
+ metadata?: {
+ [key: string]: string;
+ };
+ repo?: string;
+ dependencies?: {
+ [key: string]: string;
}[];
- readonly commit_oid?: string;
+ commit_oid?: string;
};
/** package published event */
- readonly "webhook-package-published": {
+ "webhook-package-published": {
/** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
- readonly package: {
- readonly created_at: string | null;
- readonly description: string | null;
- readonly ecosystem: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
+ package: {
+ created_at: string | null;
+ description: string | null;
+ ecosystem: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly package_type: string;
- readonly package_version: {
+ package_type: string;
+ package_version: {
/** User */
- readonly author?: {
+ author?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly body?: string | Record;
- readonly body_html?: string;
- readonly container_metadata?: {
- readonly labels?: Record | null;
- readonly manifest?: Record | null;
- readonly tag?: {
- readonly digest?: string;
- readonly name?: string;
+ body?: string | Record;
+ body_html?: string;
+ container_metadata?: {
+ labels?: Record | null;
+ manifest?: Record | null;
+ tag?: {
+ digest?: string;
+ name?: string;
};
} | null;
- readonly created_at?: string;
- readonly description: string;
- readonly docker_metadata?: readonly {
- readonly tags?: readonly string[];
+ created_at?: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
}[];
- readonly draft?: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: readonly {
- readonly [key: string]: unknown;
+ draft?: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
}[];
- readonly name: string;
- readonly npm_metadata?: {
- readonly name?: string;
- readonly version?: string;
- readonly npm_user?: string;
- readonly author?: Record | null;
- readonly bugs?: Record | null;
- readonly dependencies?: Record;
- readonly dev_dependencies?: Record;
- readonly peer_dependencies?: Record;
- readonly optional_dependencies?: Record;
- readonly description?: string;
- readonly dist?: Record | null;
- readonly git_head?: string;
- readonly homepage?: string;
- readonly license?: string;
- readonly main?: string;
- readonly repository?: Record | null;
- readonly scripts?: Record;
- readonly id?: string;
- readonly node_version?: string;
- readonly npm_version?: string;
- readonly has_shrinkwrap?: boolean;
- readonly maintainers?: readonly Record[];
- readonly contributors?: readonly Record[];
- readonly engines?: Record;
- readonly keywords?: readonly string[];
- readonly files?: readonly string[];
- readonly bin?: Record;
- readonly man?: Record;
- readonly directories?: Record | null;
- readonly os?: readonly string[];
- readonly cpu?: readonly string[];
- readonly readme?: string;
- readonly installation_command?: string;
- readonly release_id?: number;
- readonly commit_oid?: string;
- readonly published_via_actions?: boolean;
- readonly deleted_by_id?: number;
+ name: string;
+ npm_metadata?: {
+ name?: string;
+ version?: string;
+ npm_user?: string;
+ author?: Record | null;
+ bugs?: Record | null;
+ dependencies?: Record;
+ dev_dependencies?: Record;
+ peer_dependencies?: Record;
+ optional_dependencies?: Record;
+ description?: string;
+ dist?: Record | null;
+ git_head?: string;
+ homepage?: string;
+ license?: string;
+ main?: string;
+ repository?: Record | null;
+ scripts?: Record;
+ id?: string;
+ node_version?: string;
+ npm_version?: string;
+ has_shrinkwrap?: boolean;
+ maintainers?: Record[];
+ contributors?: Record[];
+ engines?: Record;
+ keywords?: string[];
+ files?: string[];
+ bin?: Record;
+ man?: Record;
+ directories?: Record | null;
+ os?: string[];
+ cpu?: string[];
+ readme?: string;
+ installation_command?: string;
+ release_id?: number;
+ commit_oid?: string;
+ published_via_actions?: boolean;
+ deleted_by_id?: number;
} | null;
- readonly nuget_metadata?: readonly {
- readonly id?: number | string;
- readonly name?: string;
- readonly value?: boolean | string | number | {
- readonly url?: string;
- readonly branch?: string;
- readonly commit?: string;
- readonly type?: string;
+ nuget_metadata?: {
+ id?: number | string;
+ name?: string;
+ value?: boolean | string | number | {
+ url?: string;
+ branch?: string;
+ commit?: string;
+ type?: string;
};
}[] | null;
- readonly package_files: readonly {
- readonly content_type: string;
- readonly created_at: string;
- /** Format: uri */
- readonly download_url: string;
- readonly id: number;
- readonly md5: string | null;
- readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string | null;
- readonly size: number;
- readonly state: string | null;
- readonly updated_at: string;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ /** Format: uri */
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string | null;
+ size: number;
+ state: string | null;
+ updated_at: string;
}[];
- readonly package_url?: string;
- readonly prerelease?: boolean;
- readonly release?: {
+ package_url?: string;
+ prerelease?: boolean;
+ release?: {
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly created_at: string;
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
- /** Format: uri */
- readonly url: string;
+ created_at: string;
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string | null;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ /** Format: uri */
+ url: string;
};
- readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][];
- readonly source_url?: string;
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly target_oid?: string;
- readonly updated_at?: string;
- readonly version: string;
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ source_url?: string;
+ summary: string;
+ tag_name?: string;
+ target_commitish?: string;
+ target_oid?: string;
+ updated_at?: string;
+ version: string;
} | null;
- readonly registry: {
+ registry: {
/** Format: uri */
- readonly about_url: string;
- readonly name: string;
- readonly type: string;
+ about_url: string;
+ name: string;
+ type: string;
/** Format: uri */
- readonly url: string;
- readonly vendor: string;
+ url: string;
+ vendor: string;
} | null;
- readonly updated_at: string | null;
+ updated_at: string | null;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** package updated event */
- readonly "webhook-package-updated": {
+ "webhook-package-updated": {
/** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** @description Information about the package. */
- readonly package: {
- readonly created_at: string;
- readonly description: string | null;
- readonly ecosystem: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
+ package: {
+ created_at: string;
+ description: string | null;
+ ecosystem: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly package_type: string;
- readonly package_version: {
+ package_type: string;
+ package_version: {
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly body: string;
- readonly body_html: string;
- readonly created_at: string;
- readonly description: string;
- readonly docker_metadata?: readonly {
- readonly tags?: readonly string[];
+ body: string;
+ body_html: string;
+ created_at: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
}[];
- readonly draft?: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: readonly {
- readonly [key: string]: unknown;
+ draft?: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
}[];
- readonly name: string;
- readonly package_files: readonly {
- readonly content_type: string;
- readonly created_at: string;
- /** Format: uri */
- readonly download_url: string;
- readonly id: number;
- readonly md5: string | null;
- readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string;
- readonly size: number;
- readonly state: string;
- readonly updated_at: string;
+ name: string;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ /** Format: uri */
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string;
+ size: number;
+ state: string;
+ updated_at: string;
}[];
- readonly package_url?: string;
- readonly prerelease?: boolean;
- readonly release?: {
+ package_url?: string;
+ prerelease?: boolean;
+ release?: {
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly created_at: string;
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
- /** Format: uri */
- readonly url: string;
+ created_at: string;
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ name: string;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ /** Format: uri */
+ url: string;
};
- readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][];
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
/** Format: uri */
- readonly source_url?: string;
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish: string;
- readonly target_oid: string;
- readonly updated_at: string;
- readonly version: string;
+ source_url?: string;
+ summary: string;
+ tag_name?: string;
+ target_commitish: string;
+ target_oid: string;
+ updated_at: string;
+ version: string;
};
- readonly registry: {
+ registry: {
/** Format: uri */
- readonly about_url: string;
- readonly name: string;
- readonly type: string;
+ about_url: string;
+ name: string;
+ type: string;
/** Format: uri */
- readonly url: string;
- readonly vendor: string;
+ url: string;
+ vendor: string;
} | null;
- readonly updated_at: string;
+ updated_at: string;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** page_build event */
- readonly "webhook-page-build": {
+ "webhook-page-build": {
/** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */
- readonly build: {
- readonly commit: string | null;
- readonly created_at: string;
- readonly duration: number;
- readonly error: {
- readonly message: string | null;
+ build: {
+ commit: string | null;
+ created_at: string;
+ duration: number;
+ error: {
+ message: string | null;
};
/** User */
- readonly pusher: {
+ pusher: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly status: string;
- readonly updated_at: string;
+ status: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ id: number;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** personal_access_token_request approved event */
- readonly "webhook-personal-access-token-request-approved": {
+ "webhook-personal-access-token-request-approved": {
/** @enum {string} */
- readonly action: "approved";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly installation: components["schemas"]["simple-installation"];
+ action: "approved";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request cancelled event */
- readonly "webhook-personal-access-token-request-cancelled": {
+ "webhook-personal-access-token-request-cancelled": {
/** @enum {string} */
- readonly action: "cancelled";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly installation: components["schemas"]["simple-installation"];
+ action: "cancelled";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ installation: components["schemas"]["simple-installation"];
};
/** personal_access_token_request created event */
- readonly "webhook-personal-access-token-request-created": {
+ "webhook-personal-access-token-request-created": {
/** @enum {string} */
- readonly action: "created";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "created";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
};
/** personal_access_token_request denied event */
- readonly "webhook-personal-access-token-request-denied": {
+ "webhook-personal-access-token-request-denied": {
/** @enum {string} */
- readonly action: "denied";
- readonly personal_access_token_request: components["schemas"]["personal-access-token-request"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly installation: components["schemas"]["simple-installation"];
+ action: "denied";
+ personal_access_token_request: components["schemas"]["personal-access-token-request"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ installation: components["schemas"]["simple-installation"];
};
- readonly "webhook-ping": {
+ "webhook-ping": {
/**
* Webhook
* @description The webhook that is being pinged
*/
- readonly hook?: {
+ hook?: {
/** @description Determines whether the hook is actually triggered for the events it subscribes to. */
- readonly active: boolean;
+ active: boolean;
/** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */
- readonly app_id?: number;
- readonly config: {
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly url?: components["schemas"]["webhook-config-url"];
+ app_id?: number;
+ config: {
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ url?: components["schemas"]["webhook-config-url"];
};
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** Format: uri */
- readonly deliveries_url?: string;
+ deliveries_url?: string;
/** @description Determines what events the hook is triggered for. Default: ['push']. */
- readonly events: readonly string[];
+ events: string[];
/** @description Unique identifier of the webhook. */
- readonly id: number;
- readonly last_response?: components["schemas"]["hook-response"];
+ id: number;
+ last_response?: components["schemas"]["hook-response"];
/**
* @description The type of webhook. The only valid value is 'web'.
* @enum {string}
*/
- readonly name: "web";
+ name: "web";
/** Format: uri */
- readonly ping_url?: string;
+ ping_url?: string;
/** Format: uri */
- readonly test_url?: string;
- readonly type: string;
+ test_url?: string;
+ type: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
};
/** @description The ID of the webhook that triggered the ping. */
- readonly hook_id?: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ hook_id?: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
/** @description Random string of GitHub zen. */
- readonly zen?: string;
+ zen?: string;
};
/** @description The webhooks ping payload encoded with URL encoding. */
- readonly "webhook-ping-form-encoded": {
+ "webhook-ping-form-encoded": {
/** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** project_card converted event */
- readonly "webhook-project-card-converted": {
+ "webhook-project-card-converted": {
/** @enum {string} */
- readonly action: "converted";
- readonly changes: {
- readonly note: {
- readonly from: string;
+ action: "converted";
+ changes: {
+ note: {
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_card: components["schemas"]["webhooks_project_card"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_card: components["schemas"]["webhooks_project_card"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project_card created event */
- readonly "webhook-project-card-created": {
+ "webhook-project-card-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_card: components["schemas"]["webhooks_project_card"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_card: components["schemas"]["webhooks_project_card"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project_card deleted event */
- readonly "webhook-project-card-deleted": {
+ "webhook-project-card-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Project Card */
- readonly project_card: {
- readonly after_id?: number | null;
+ project_card: {
+ after_id?: number | null;
/** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number | null;
+ archived: boolean;
+ column_id: number | null;
/** Format: uri */
- readonly column_url: string;
+ column_url: string;
/** Format: uri */
- readonly content_url?: string;
+ content_url?: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
+ id: number;
+ node_id: string;
+ note: string | null;
/** Format: uri */
- readonly project_url: string;
+ project_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project_card edited event */
- readonly "webhook-project-card-edited": {
+ "webhook-project-card-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly note: {
- readonly from: string | null;
+ action: "edited";
+ changes: {
+ note: {
+ from: string | null;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_card: components["schemas"]["webhooks_project_card"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_card: components["schemas"]["webhooks_project_card"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project_card moved event */
- readonly "webhook-project-card-moved": {
+ "webhook-project-card-moved": {
/** @enum {string} */
- readonly action: "moved";
- readonly changes?: {
- readonly column_id: {
- readonly from: number;
+ action: "moved";
+ changes?: {
+ column_id: {
+ from: number;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_card: {
- readonly after_id?: number | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_card: {
+ after_id?: number | null;
/** @description Whether or not the card is archived */
- readonly archived: boolean;
- readonly column_id: number;
+ archived: boolean;
+ column_id: number;
/** Format: uri */
- readonly column_url: string;
+ column_url: string;
/** Format: uri */
- readonly content_url?: string;
+ content_url?: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description The project card's ID */
- readonly id: number;
- readonly node_id: string;
- readonly note: string | null;
+ id: number;
+ node_id: string;
+ note: string | null;
/** Format: uri */
- readonly project_url: string;
+ project_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} & {
- readonly after_id: number | null;
- readonly archived?: boolean;
- readonly column_id?: number;
- readonly column_url?: string;
- readonly created_at?: string;
- readonly creator?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
+ after_id: number | null;
+ archived?: boolean;
+ column_id?: number;
+ column_url?: string;
+ created_at?: string;
+ creator?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
} | null;
- readonly id?: number;
- readonly node_id?: string;
- readonly note?: string | null;
- readonly project_url?: string;
- readonly updated_at?: string;
- readonly url?: string;
+ id?: number;
+ node_id?: string;
+ note?: string | null;
+ project_url?: string;
+ updated_at?: string;
+ url?: string;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project closed event */
- readonly "webhook-project-closed": {
+ "webhook-project-closed": {
/** @enum {string} */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project: components["schemas"]["webhooks_project"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project: components["schemas"]["webhooks_project"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project_column created event */
- readonly "webhook-project-column-created": {
+ "webhook-project-column-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_column: components["schemas"]["webhooks_project_column"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_column: components["schemas"]["webhooks_project_column"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** project_column deleted event */
- readonly "webhook-project-column-deleted": {
+ "webhook-project-column-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_column: components["schemas"]["webhooks_project_column"];
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_column: components["schemas"]["webhooks_project_column"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** project_column edited event */
- readonly "webhook-project-column-edited": {
+ "webhook-project-column-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly name?: {
- readonly from: string;
+ action: "edited";
+ changes: {
+ name?: {
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_column: components["schemas"]["webhooks_project_column"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_column: components["schemas"]["webhooks_project_column"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** project_column moved event */
- readonly "webhook-project-column-moved": {
+ "webhook-project-column-moved": {
/** @enum {string} */
- readonly action: "moved";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project_column: components["schemas"]["webhooks_project_column"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "moved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project_column: components["schemas"]["webhooks_project_column"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project created event */
- readonly "webhook-project-created": {
+ "webhook-project-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project: components["schemas"]["webhooks_project"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project: components["schemas"]["webhooks_project"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** project deleted event */
- readonly "webhook-project-deleted": {
+ "webhook-project-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project: components["schemas"]["webhooks_project"];
- readonly repository?: components["schemas"]["nullable-repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project: components["schemas"]["webhooks_project"];
+ repository?: components["schemas"]["nullable-repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** project edited event */
- readonly "webhook-project-edited": {
+ "webhook-project-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the project if the action was `edited`. */
- readonly changes?: {
- readonly body?: {
+ changes?: {
+ body?: {
/** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly name?: {
+ name?: {
/** @description The changes to the project if the action was `edited`. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project: components["schemas"]["webhooks_project"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project: components["schemas"]["webhooks_project"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** project reopened event */
- readonly "webhook-project-reopened": {
+ "webhook-project-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly project: components["schemas"]["webhooks_project"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ project: components["schemas"]["webhooks_project"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Project Closed Event */
- readonly "webhook-projects-v2-project-closed": {
+ "webhook-projects-v2-project-closed": {
/** @enum {string} */
- readonly action: "closed";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "closed";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user"];
};
/** @description A project was created */
- readonly "webhook-projects-v2-project-created": {
+ "webhook-projects-v2-project-created": {
/** @enum {string} */
- readonly action: "created";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Project Deleted Event */
- readonly "webhook-projects-v2-project-deleted": {
+ "webhook-projects-v2-project-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Project Edited Event */
- readonly "webhook-projects-v2-project-edited": {
+ "webhook-projects-v2-project-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly description?: {
- readonly from?: string | null;
- readonly to?: string | null;
+ action: "edited";
+ changes: {
+ description?: {
+ from?: string | null;
+ to?: string | null;
};
- readonly public?: {
- readonly from?: boolean;
- readonly to?: boolean;
+ public?: {
+ from?: boolean;
+ to?: boolean;
};
- readonly short_description?: {
- readonly from?: string | null;
- readonly to?: string | null;
+ short_description?: {
+ from?: string | null;
+ to?: string | null;
};
- readonly title?: {
- readonly from?: string;
- readonly to?: string;
+ title?: {
+ from?: string;
+ to?: string;
};
};
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Archived Event */
- readonly "webhook-projects-v2-item-archived": {
+ "webhook-projects-v2-item-archived": {
/** @enum {string} */
- readonly action: "archived";
- readonly changes: components["schemas"]["webhooks_project_changes"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "archived";
+ changes: components["schemas"]["webhooks_project_changes"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Converted Event */
- readonly "webhook-projects-v2-item-converted": {
+ "webhook-projects-v2-item-converted": {
/** @enum {string} */
- readonly action: "converted";
- readonly changes: {
- readonly content_type?: {
- readonly from?: string | null;
- readonly to?: string;
+ action: "converted";
+ changes: {
+ content_type?: {
+ from?: string | null;
+ to?: string;
};
};
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Created Event */
- readonly "webhook-projects-v2-item-created": {
+ "webhook-projects-v2-item-created": {
/** @enum {string} */
- readonly action: "created";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Deleted Event */
- readonly "webhook-projects-v2-item-deleted": {
+ "webhook-projects-v2-item-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Edited Event */
- readonly "webhook-projects-v2-item-edited": {
+ "webhook-projects-v2-item-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/**
* @description The changes made to the item may involve modifications in the item's fields and draft issue body.
* It includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.
*/
- readonly changes?: {
- readonly field_value: {
- readonly field_node_id?: string;
- readonly field_type?: string;
- readonly field_name?: string;
- readonly project_number?: number;
- readonly from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null;
- readonly to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null;
+ changes?: {
+ field_value: {
+ field_node_id?: string;
+ field_type?: string;
+ field_name?: string;
+ project_number?: number;
+ from?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null;
+ to?: (string | number | components["schemas"]["projects-v2-single-select-option"] | components["schemas"]["projects-v2-iteration-setting"]) | null;
};
} | {
- readonly body: {
- readonly from?: string | null;
- readonly to?: string | null;
+ body: {
+ from?: string | null;
+ to?: string | null;
};
};
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Reordered Event */
- readonly "webhook-projects-v2-item-reordered": {
+ "webhook-projects-v2-item-reordered": {
/** @enum {string} */
- readonly action: "reordered";
- readonly changes: {
- readonly previous_projects_v2_item_node_id?: {
- readonly from?: string | null;
- readonly to?: string | null;
+ action: "reordered";
+ changes: {
+ previous_projects_v2_item_node_id?: {
+ from?: string | null;
+ to?: string | null;
};
};
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Item Restored Event */
- readonly "webhook-projects-v2-item-restored": {
+ "webhook-projects-v2-item-restored": {
/** @enum {string} */
- readonly action: "restored";
- readonly changes: components["schemas"]["webhooks_project_changes"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_item: components["schemas"]["projects-v2-item"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "restored";
+ changes: components["schemas"]["webhooks_project_changes"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_item: components["schemas"]["projects-v2-item"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Project Reopened Event */
- readonly "webhook-projects-v2-project-reopened": {
+ "webhook-projects-v2-project-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2: components["schemas"]["projects-v2"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopened";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2: components["schemas"]["projects-v2"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Status Update Created Event */
- readonly "webhook-projects-v2-status-update-created": {
+ "webhook-projects-v2-status-update-created": {
/** @enum {string} */
- readonly action: "created";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Status Update Deleted Event */
- readonly "webhook-projects-v2-status-update-deleted": {
+ "webhook-projects-v2-status-update-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
+ sender: components["schemas"]["simple-user"];
};
/** Projects v2 Status Update Edited Event */
- readonly "webhook-projects-v2-status-update-edited": {
+ "webhook-projects-v2-status-update-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes?: {
- readonly body?: {
- readonly from?: string | null;
- readonly to?: string | null;
+ action: "edited";
+ changes?: {
+ body?: {
+ from?: string | null;
+ to?: string | null;
};
- readonly status?: {
+ status?: {
/** @enum {string|null} */
- readonly from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
+ from?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
/** @enum {string|null} */
- readonly to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
+ to?: "INACTIVE" | "ON_TRACK" | "AT_RISK" | "OFF_TRACK" | "COMPLETE" | null;
};
- readonly start_date?: {
+ start_date?: {
/** Format: date */
- readonly from?: string | null;
+ from?: string | null;
/** Format: date */
- readonly to?: string | null;
+ to?: string | null;
};
- readonly target_date?: {
+ target_date?: {
/** Format: date */
- readonly from?: string | null;
+ from?: string | null;
/** Format: date */
- readonly to?: string | null;
+ to?: string | null;
};
};
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
- readonly projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
- readonly sender: components["schemas"]["simple-user"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
+ projects_v2_status_update: components["schemas"]["projects-v2-status-update"];
+ sender: components["schemas"]["simple-user"];
};
/** public event */
- readonly "webhook-public": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ "webhook-public": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request assigned event */
- readonly "webhook-pull-request-assigned": {
+ "webhook-pull-request-assigned": {
/** @enum {string} */
- readonly action: "assigned";
- readonly assignee: components["schemas"]["webhooks_user"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "assigned";
+ assignee: components["schemas"]["webhooks_user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -54894,7 +59067,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -54902,76 +59075,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -54980,7 +59153,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -54988,250 +59161,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -55240,7 +59423,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -55248,76 +59431,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -55326,7 +59509,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -55334,765 +59517,775 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request auto_merge_disabled event */
- readonly "webhook-pull-request-auto-merge-disabled": {
+ "webhook-pull-request-auto-merge-disabled": {
/** @enum {string} */
- readonly action: "auto_merge_disabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "auto_merge_disabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
+ has_issues: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly has_pages: boolean;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -56101,7 +60294,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -56109,76 +60302,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -56187,7 +60380,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -56195,250 +60388,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -56447,7 +60650,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -56455,76 +60658,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -56533,7 +60736,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -56541,766 +60744,776 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly reason: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ reason: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request auto_merge_enabled event */
- readonly "webhook-pull-request-auto-merge-enabled": {
+ "webhook-pull-request-auto-merge-enabled": {
/** @enum {string} */
- readonly action: "auto_merge_enabled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "auto_merge_enabled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -57309,7 +61522,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -57317,76 +61530,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -57395,7 +61608,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -57403,247 +61616,257 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -57652,7 +61875,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -57660,76 +61883,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -57738,7 +61961,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -57746,802 +61969,812 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly reason?: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ reason?: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request closed event */
- readonly "webhook-pull-request-closed": {
+ "webhook-pull-request-closed": {
/** @enum {string} */
- readonly action: "closed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "closed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request converted_to_draft event */
- readonly "webhook-pull-request-converted-to-draft": {
+ "webhook-pull-request-converted-to-draft": {
/** @enum {string} */
- readonly action: "converted_to_draft";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "converted_to_draft";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request demilestoned event */
- readonly "webhook-pull-request-demilestoned": {
+ "webhook-pull-request-demilestoned": {
/** @enum {string} */
- readonly action: "demilestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly milestone?: components["schemas"]["milestone"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["webhooks_pull_request_5"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "demilestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ milestone?: components["schemas"]["milestone"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["webhooks_pull_request_5"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** pull_request dequeued event */
- readonly "webhook-pull-request-dequeued": {
+ "webhook-pull-request-dequeued": {
/** @enum {string} */
- readonly action: "dequeued";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "dequeued";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -58550,7 +62783,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -58558,76 +62791,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -58636,7 +62869,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -58644,250 +62877,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -58896,7 +63139,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -58904,76 +63147,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -58982,7 +63225,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -58990,798 +63233,808 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** @enum {string} */
- readonly reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT";
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ reason: "UNKNOWN_REMOVAL_REASON" | "MANUAL" | "MERGE" | "MERGE_CONFLICT" | "CI_FAILURE" | "CI_TIMEOUT" | "ALREADY_MERGED" | "QUEUE_CLEARED" | "ROLL_BACK" | "BRANCH_PROTECTIONS" | "GIT_TREE_INVALID" | "INVALID_MERGE_COMMIT";
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request edited event */
- readonly "webhook-pull-request-edited": {
+ "webhook-pull-request-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the comment if the action was `edited`. */
- readonly changes: {
- readonly base?: {
- readonly ref: {
- readonly from: string;
+ changes: {
+ base?: {
+ ref: {
+ from: string;
};
- readonly sha: {
- readonly from: string;
+ sha: {
+ from: string;
};
};
- readonly body?: {
+ body?: {
/** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly title?: {
+ title?: {
/** @description The previous version of the title if the action was `edited`. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** pull_request enqueued event */
- readonly "webhook-pull-request-enqueued": {
+ "webhook-pull-request-enqueued": {
/** @enum {string} */
- readonly action: "enqueued";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "enqueued";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -59790,7 +64043,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -59798,76 +64051,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -59876,7 +64129,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -59884,250 +64137,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -60136,7 +64399,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -60144,76 +64407,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -60222,7 +64485,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -60230,766 +64493,776 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request labeled event */
- readonly "webhook-pull-request-labeled": {
+ "webhook-pull-request-labeled": {
/** @enum {string} */
- readonly action: "labeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label?: components["schemas"]["webhooks_label"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "labeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label?: components["schemas"]["webhooks_label"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -60998,7 +65271,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -61006,76 +65279,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -61084,7 +65357,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -61092,250 +65365,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -61344,7 +65627,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -61352,76 +65635,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -61430,7 +65713,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -61438,765 +65721,775 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request locked event */
- readonly "webhook-pull-request-locked": {
+ "webhook-pull-request-locked": {
/** @enum {string} */
- readonly action: "locked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "locked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -62205,7 +66498,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -62213,76 +66506,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -62291,7 +66584,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -62299,250 +66592,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -62551,7 +66854,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -62559,76 +66862,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -62637,7 +66940,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -62645,500 +66948,500 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request milestoned event */
- readonly "webhook-pull-request-milestoned": {
+ "webhook-pull-request-milestoned": {
/** @enum {string} */
- readonly action: "milestoned";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly milestone?: components["schemas"]["milestone"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["webhooks_pull_request_5"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "milestoned";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ milestone?: components["schemas"]["milestone"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["webhooks_pull_request_5"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** pull_request opened event */
- readonly "webhook-pull-request-opened": {
+ "webhook-pull-request-opened": {
/** @enum {string} */
- readonly action: "opened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "opened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request ready_for_review event */
- readonly "webhook-pull-request-ready-for-review": {
+ "webhook-pull-request-ready-for-review": {
/** @enum {string} */
- readonly action: "ready_for_review";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "ready_for_review";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request reopened event */
- readonly "webhook-pull-request-reopened": {
+ "webhook-pull-request-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: components["schemas"]["pull-request-webhook"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopened";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: components["schemas"]["pull-request-webhook"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review_comment created event */
- readonly "webhook-pull-request-review-comment-created": {
+ "webhook-pull-request-review-comment-created": {
/** @enum {string} */
- readonly action: "created";
+ action: "created";
/**
* Pull Request Review Comment
* @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself.
*/
- readonly comment: {
- readonly _links: {
+ comment: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -63146,456 +67449,466 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the comment. */
- readonly body: string;
+ body: string;
/** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
+ diff_hunk: string;
/**
* Format: uri
* @description HTML URL for the pull request review comment.
*/
- readonly html_url: string;
+ html_url: string;
/** @description The ID of the pull request review comment. */
- readonly id: number;
+ id: number;
/** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
+ in_reply_to_id?: number;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
+ line: number | null;
/** @description The node ID of the pull request review comment. */
- readonly node_id: string;
+ node_id: string;
/** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
+ original_commit_id: string;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number | null;
+ original_line: number | null;
/** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
+ original_position: number;
/** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
+ original_start_line: number | null;
/** @description The relative path of the file to which the comment applies. */
- readonly path: string;
+ path: string;
/** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
+ position: number | null;
/** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: uri
* @description URL for the pull request that the review comment belongs to.
*/
- readonly pull_request_url: string;
+ pull_request_url: string;
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/**
* @description The side of the first line of the range for a multi-line comment.
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
+ start_line: number | null;
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly subject_type?: "line" | "file";
+ subject_type?: "line" | "file";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the pull request review comment
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: {
- readonly _links: {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge?: {
+ auto_merge?: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -63604,7 +67917,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -63612,76 +67925,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -63690,7 +68003,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -63698,243 +68011,253 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft?: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -63943,7 +68266,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -63951,76 +68274,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -64029,7 +68352,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -64037,711 +68360,721 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review_comment deleted event */
- readonly "webhook-pull-request-review-comment-deleted": {
+ "webhook-pull-request-review-comment-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly comment: components["schemas"]["webhooks_review_comment"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: {
- readonly _links: {
+ action: "deleted";
+ comment: components["schemas"]["webhooks_review_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge?: {
+ auto_merge?: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -64750,7 +69083,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -64758,76 +69091,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -64836,7 +69169,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -64844,243 +69177,253 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft?: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -65089,7 +69432,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -65097,76 +69440,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -65175,7 +69518,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -65183,713 +69526,723 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review_comment edited event */
- readonly "webhook-pull-request-review-comment-edited": {
+ "webhook-pull-request-review-comment-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: components["schemas"]["webhooks_changes"];
- readonly comment: components["schemas"]["webhooks_review_comment"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly pull_request: {
- readonly _links: {
+ action: "edited";
+ changes: components["schemas"]["webhooks_changes"];
+ comment: components["schemas"]["webhooks_review_comment"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge?: {
+ auto_merge?: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -65898,7 +70251,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -65906,76 +70259,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -65984,7 +70337,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -65992,243 +70345,253 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft?: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft?: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -66237,7 +70600,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -66245,76 +70608,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -66323,7 +70686,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -66331,711 +70694,721 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
- readonly user_view_type?: string;
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
+ user_view_type?: string;
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review dismissed event */
- readonly "webhook-pull-request-review-dismissed": {
+ "webhook-pull-request-review-dismissed": {
/** @enum {string} */
- readonly action: "dismissed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "dismissed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -67044,7 +71417,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -67052,76 +71425,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -67130,7 +71503,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -67138,243 +71511,253 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -67383,7 +71766,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -67391,76 +71774,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -67469,7 +71852,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -67477,386 +71860,386 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** @description The review that was affected. */
- readonly review: {
- readonly _links: {
+ review: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -67864,1464 +72247,1476 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the review. */
- readonly body: string | null;
+ body: string | null;
/** @description A commit SHA for the review. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the review */
- readonly id: number;
- readonly node_id: string;
+ id: number;
+ node_id: string;
/** Format: uri */
- readonly pull_request_url: string;
+ pull_request_url: string;
/** @enum {string} */
- readonly state: "dismissed" | "approved" | "changes_requested";
+ state: "dismissed" | "approved" | "changes_requested";
+ /** Format: date-time */
+ submitted_at: string;
/** Format: date-time */
- readonly submitted_at: string;
+ updated_at?: string | null;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review edited event */
- readonly "webhook-pull-request-review-edited": {
+ "webhook-pull-request-review-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body?: {
+ action: "edited";
+ changes: {
+ body?: {
/** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly review: components["schemas"]["webhooks_review"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ review: components["schemas"]["webhooks_review"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request review_request_removed event */
- readonly "webhook-pull-request-review-request-removed": {
+ "webhook-pull-request-review-request-removed": {
/** @enum {string} */
- readonly action: "review_request_removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "review_request_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -69330,7 +73725,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -69338,329 +73733,339 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title.
* @enum {string}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -69669,7 +74074,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -69677,76 +74082,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -69755,7 +74160,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -69763,803 +74168,813 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
- readonly requested_reviewer: {
+ requested_reviewer: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
} | {
/** @enum {string} */
- readonly action: "review_request_removed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "review_request_removed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -70568,7 +74983,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -70576,76 +74991,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -70654,7 +75069,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -70662,250 +75077,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -70914,7 +75339,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -70922,76 +75347,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -71000,7 +75425,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -71008,822 +75433,832 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly requested_team: {
- readonly deleted?: boolean;
+ requested_team: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
};
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request review_requested event */
- readonly "webhook-pull-request-review-requested": {
+ "webhook-pull-request-review-requested": {
/** @enum {string} */
- readonly action: "review_requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "review_requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -71832,7 +76267,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -71840,76 +76275,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -71918,7 +76353,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -71926,250 +76361,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -72178,7 +76623,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -72186,76 +76631,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -72264,7 +76709,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -72272,803 +76717,813 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/** User */
- readonly requested_reviewer: {
+ requested_reviewer: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
} | {
/** @enum {string} */
- readonly action: "review_requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
+ action: "review_requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
/** @description The pull request number. */
- readonly number: number;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ number: number;
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -73077,7 +77532,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -73085,76 +77540,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -73163,7 +77618,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -73171,250 +77626,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -73423,7 +77888,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -73431,76 +77896,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -73509,7 +77974,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -73517,818 +77982,828 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
/**
* Team
* @description Groups of organization members that gives permissions on specified repositories.
*/
- readonly requested_team: {
- readonly deleted?: boolean;
+ requested_team: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
};
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review submitted event */
- readonly "webhook-pull-request-review-submitted": {
+ "webhook-pull-request-review-submitted": {
/** @enum {string} */
- readonly action: "submitted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "submitted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -74337,7 +78812,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -74345,76 +78820,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -74423,7 +78898,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -74431,243 +78906,253 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -74676,7 +79161,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -74684,76 +79169,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -74762,7 +79247,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -74770,1461 +79255,1481 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly review: components["schemas"]["webhooks_review"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ review: components["schemas"]["webhooks_review"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request_review_thread resolved event */
- readonly "webhook-pull-request-review-thread-resolved": {
+ "webhook-pull-request-review-thread-resolved": {
/** @enum {string} */
- readonly action: "resolved";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "resolved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
- readonly thread: {
- readonly comments: readonly {
- readonly _links: {
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ thread: {
+ comments: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -76232,1213 +80737,1235 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the comment. */
- readonly body: string;
+ body: string;
/** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
+ diff_hunk: string;
/**
* Format: uri
* @description HTML URL for the pull request review comment.
*/
- readonly html_url: string;
+ html_url: string;
/** @description The ID of the pull request review comment. */
- readonly id: number;
+ id: number;
/** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
+ in_reply_to_id?: number;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
+ line: number | null;
/** @description The node ID of the pull request review comment. */
- readonly node_id: string;
+ node_id: string;
/** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
+ original_commit_id: string;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number | null;
+ original_line: number | null;
/** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
+ original_position: number;
/** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
+ original_start_line: number | null;
/** @description The relative path of the file to which the comment applies. */
- readonly path: string;
+ path: string;
/** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
+ position: number | null;
/** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: uri
* @description URL for the pull request that the review comment belongs to.
*/
- readonly pull_request_url: string;
+ pull_request_url: string;
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/**
* @description The side of the first line of the range for a multi-line comment.
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
+ start_line: number | null;
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly subject_type?: "line" | "file";
+ subject_type?: "line" | "file";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the pull request review comment
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
}[];
- readonly node_id: string;
+ node_id: string;
};
+ /** Format: date-time */
+ updated_at?: string | null;
};
/** pull_request_review_thread unresolved event */
- readonly "webhook-pull-request-review-thread-unresolved": {
+ "webhook-pull-request-review-thread-unresolved": {
/** @enum {string} */
- readonly action: "unresolved";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "unresolved";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Simple Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string;
+ commit_title: string;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly closed_at: string | null;
+ body: string | null;
+ closed_at: string | null;
/** Format: uri */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri */
- readonly commits_url: string;
- readonly created_at: string;
+ commits_url: string;
+ created_at: string;
/** Format: uri */
- readonly diff_url: string;
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ diff_url: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
- readonly merge_commit_sha: string | null;
- readonly merged_at: string | null;
+ locked: boolean;
+ merge_commit_sha: string | null;
+ merged_at: string | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
- readonly number: number;
+ node_id: string;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
+ review_comment_url: string;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/** @enum {string} */
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
- readonly title: string;
- readonly updated_at: string;
+ statuses_url: string;
+ title: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
- readonly thread: {
- readonly comments: readonly {
- readonly _links: {
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ thread: {
+ comments: {
+ _links: {
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly pull_request: {
+ pull_request: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/**
@@ -77446,468 +81973,480 @@ export type components = {
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/** @description The text of the comment. */
- readonly body: string;
+ body: string;
/** @description The SHA of the commit to which the comment applies. */
- readonly commit_id: string;
+ commit_id: string;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** @description The diff of the line that the comment refers to. */
- readonly diff_hunk: string;
+ diff_hunk: string;
/**
* Format: uri
* @description HTML URL for the pull request review comment.
*/
- readonly html_url: string;
+ html_url: string;
/** @description The ID of the pull request review comment. */
- readonly id: number;
+ id: number;
/** @description The comment ID to reply to. */
- readonly in_reply_to_id?: number;
+ in_reply_to_id?: number;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly line: number | null;
+ line: number | null;
/** @description The node ID of the pull request review comment. */
- readonly node_id: string;
+ node_id: string;
/** @description The SHA of the original commit to which the comment applies. */
- readonly original_commit_id: string;
+ original_commit_id: string;
/** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */
- readonly original_line: number;
+ original_line: number;
/** @description The index of the original line in the diff to which the comment applies. */
- readonly original_position: number;
+ original_position: number;
/** @description The first line of the range for a multi-line comment. */
- readonly original_start_line: number | null;
+ original_start_line: number | null;
/** @description The relative path of the file to which the comment applies. */
- readonly path: string;
+ path: string;
/** @description The line index in the diff to which the comment applies. */
- readonly position: number | null;
+ position: number | null;
/** @description The ID of the pull request review to which the comment belongs. */
- readonly pull_request_review_id: number | null;
+ pull_request_review_id: number | null;
/**
* Format: uri
* @description URL for the pull request that the review comment belongs to.
*/
- readonly pull_request_url: string;
+ pull_request_url: string;
/** Reactions */
- readonly reactions: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/**
* @description The side of the first line of the range for a multi-line comment.
* @enum {string}
*/
- readonly side: "LEFT" | "RIGHT";
+ side: "LEFT" | "RIGHT";
/** @description The first line of the range for a multi-line comment. */
- readonly start_line: number | null;
+ start_line: number | null;
/**
* @description The side of the first line of the range for a multi-line comment.
* @default RIGHT
* @enum {string|null}
*/
- readonly start_side: "LEFT" | "RIGHT" | null;
+ start_side: "LEFT" | "RIGHT" | null;
/**
* @description The level at which the comment is targeted, can be a diff line or a file.
* @enum {string}
*/
- readonly subject_type?: "line" | "file";
+ subject_type?: "line" | "file";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/**
* Format: uri
* @description URL for the pull request review comment
*/
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
}[];
- readonly node_id: string;
+ node_id: string;
};
+ /** Format: date-time */
+ updated_at?: string | null;
};
/** pull_request synchronize event */
- readonly "webhook-pull-request-synchronize": {
+ "webhook-pull-request-synchronize": {
/** @enum {string} */
- readonly action: "synchronize";
- readonly after: string;
- readonly before: string;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "synchronize";
+ after: string;
+ before: string;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -77916,7 +82455,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -77924,76 +82463,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -78002,7 +82541,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -78010,329 +82549,339 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit message title.
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -78341,7 +82890,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -78349,766 +82898,776 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request unassigned event */
- readonly "webhook-pull-request-unassigned": {
+ "webhook-pull-request-unassigned": {
/** @enum {string} */
- readonly action: "unassigned";
- readonly assignee?: components["schemas"]["webhooks_user_mannequin"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "unassigned";
+ assignee?: components["schemas"]["webhooks_user_mannequin"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string | null;
- readonly ref: string;
+ base: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -79117,7 +83676,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -79125,76 +83684,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -79203,7 +83762,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -79211,250 +83770,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -79463,7 +84032,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -79471,76 +84040,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -79549,7 +84118,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -79557,766 +84126,776 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** pull_request unlabeled event */
- readonly "webhook-pull-request-unlabeled": {
+ "webhook-pull-request-unlabeled": {
/** @enum {string} */
- readonly action: "unlabeled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly label?: components["schemas"]["webhooks_label"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "unlabeled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ label?: components["schemas"]["webhooks_label"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string | null;
+ commit_title: string | null;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -80325,7 +84904,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -80333,76 +84912,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -80411,7 +84990,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -80419,329 +84998,339 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string | null;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string | null;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit message title.
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -80750,7 +85339,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -80758,765 +85347,775 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
- readonly parent?: {
+ name: string;
+ node_id: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization" | "Mannequin";
+ type?: "Bot" | "User" | "Organization" | "Mannequin";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** pull_request unlocked event */
- readonly "webhook-pull-request-unlocked": {
+ "webhook-pull-request-unlocked": {
/** @enum {string} */
- readonly action: "unlocked";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly number: components["schemas"]["webhooks_number"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "unlocked";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ number: components["schemas"]["webhooks_number"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/** Pull Request */
- readonly pull_request: {
- readonly _links: {
+ pull_request: {
+ _links: {
/** Link */
- readonly comments: {
+ comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly commits: {
+ commits: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly html: {
+ html: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly issue: {
+ issue: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comment: {
+ review_comment: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly review_comments: {
+ review_comments: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly self: {
+ self: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
/** Link */
- readonly statuses: {
+ statuses: {
/** Format: uri-template */
- readonly href: string;
+ href: string;
};
};
/** @enum {string|null} */
- readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
- readonly additions?: number;
+ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null;
+ additions?: number;
/** User */
- readonly assignee: {
+ assignee: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly assignees: readonly ({
+ assignees: ({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null)[];
/**
* AuthorAssociation
* @description How the author is associated with the repository.
* @enum {string}
*/
- readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
+ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER";
/**
* PullRequestAutoMerge
* @description The status of auto merging a pull request.
*/
- readonly auto_merge: {
+ auto_merge: {
/** @description Commit message for the merge commit. */
- readonly commit_message: string | null;
+ commit_message: string | null;
/** @description Title for the merge commit message. */
- readonly commit_title: string;
+ commit_title: string;
/** User */
- readonly enabled_by: {
+ enabled_by: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* @description The merge method to use.
* @enum {string}
*/
- readonly merge_method: "merge" | "squash" | "rebase";
+ merge_method: "merge" | "squash" | "rebase";
} | null;
- readonly base: {
- readonly label: string;
- readonly ref: string;
+ base: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -81525,7 +86124,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -81533,76 +86132,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -81611,7 +86210,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -81619,250 +86218,260 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly body: string | null;
- readonly changed_files?: number;
+ body: string | null;
+ changed_files?: number;
/** Format: date-time */
- readonly closed_at: string | null;
- readonly comments?: number;
+ closed_at: string | null;
+ comments?: number;
/** Format: uri */
- readonly comments_url: string;
- readonly commits?: number;
+ comments_url: string;
+ commits?: number;
/** Format: uri */
- readonly commits_url: string;
+ commits_url: string;
/** Format: date-time */
- readonly created_at: string;
- readonly deletions?: number;
+ created_at: string;
+ deletions?: number;
/** Format: uri */
- readonly diff_url: string;
+ diff_url: string;
/** @description Indicates whether or not the pull request is a draft. */
- readonly draft: boolean;
- readonly head: {
- readonly label: string;
- readonly ref: string;
+ draft: boolean;
+ head: {
+ label: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repo: {
+ repo: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/**
* @description The default value for a merge commit message.
*
@@ -81871,7 +86480,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description The default value for a merge commit title.
*
@@ -81879,76 +86488,76 @@ export type components = {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
/**
* @description The default value for a squash merge commit message:
*
@@ -81957,7 +86566,7 @@ export type components = {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description The default value for a squash merge commit title:
*
@@ -81965,5727 +86574,6204 @@ export type components = {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/**
* @description Whether a squash merge commit can use the pull request title as default. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default: boolean;
+ use_squash_pr_title_as_default: boolean;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
} | null;
- readonly sha: string;
+ sha: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly issue_url: string;
- readonly labels: readonly {
+ issue_url: string;
+ labels: {
/** @description 6-character hex code, without the leading #, identifying the color */
- readonly color: string;
- readonly default: boolean;
- readonly description: string | null;
- readonly id: number;
+ color: string;
+ default: boolean;
+ description: string | null;
+ id: number;
/** @description The name of the label. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/**
* Format: uri
* @description URL for the label
*/
- readonly url: string;
+ url: string;
}[];
- readonly locked: boolean;
+ locked: boolean;
/** @description Indicates whether maintainers can modify the pull request. */
- readonly maintainer_can_modify?: boolean;
- readonly merge_commit_sha: string | null;
- readonly mergeable?: boolean | null;
- readonly mergeable_state?: string;
- readonly merged?: boolean | null;
+ maintainer_can_modify?: boolean;
+ merge_commit_sha: string | null;
+ mergeable?: boolean | null;
+ mergeable_state?: string;
+ merged?: boolean | null;
/** Format: date-time */
- readonly merged_at: string | null;
+ merged_at: string | null;
/** User */
- readonly merged_by?: {
+ merged_by?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/**
* Milestone
* @description A collection of related issues and pull requests.
*/
- readonly milestone: {
+ milestone: {
/** Format: date-time */
- readonly closed_at: string | null;
- readonly closed_issues: number;
+ closed_at: string | null;
+ closed_issues: number;
/** Format: date-time */
- readonly created_at: string;
+ created_at: string;
/** User */
- readonly creator: {
+ creator: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly description: string | null;
+ description: string | null;
/** Format: date-time */
- readonly due_on: string | null;
+ due_on: string | null;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly labels_url: string;
- readonly node_id: string;
+ labels_url: string;
+ node_id: string;
/** @description The number of the milestone. */
- readonly number: number;
- readonly open_issues: number;
+ number: number;
+ open_issues: number;
/**
* @description The state of the milestone.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** @description The title of the milestone. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null;
- readonly node_id: string;
+ node_id: string;
/** @description Number uniquely identifying the pull request within its repository. */
- readonly number: number;
+ number: number;
/** Format: uri */
- readonly patch_url: string;
- readonly rebaseable?: boolean | null;
- readonly requested_reviewers: readonly (({
+ patch_url: string;
+ rebaseable?: boolean | null;
+ requested_reviewers: (({
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null) | {
- readonly deleted?: boolean;
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
})[];
- readonly requested_teams: readonly {
- readonly deleted?: boolean;
+ requested_teams: {
+ deleted?: boolean;
/** @description Description of the team */
- readonly description?: string | null;
+ description?: string | null;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url?: string;
+ members_url?: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id?: string;
- readonly parent?: {
+ name: string;
+ node_id?: string;
+ parent?: {
/** @description Description of the team */
- readonly description: string | null;
+ description: string | null;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the team */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly members_url: string;
+ members_url: string;
/** @description Name of the team */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** @description Permission that the team will have for its repositories */
- readonly permission: string;
+ permission: string;
/** @enum {string} */
- readonly privacy: "open" | "closed" | "secret";
+ privacy: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url: string;
- readonly slug: string;
+ repositories_url: string;
+ slug: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url: string;
+ url: string;
} | null;
/** @description Permission that the team will have for its repositories */
- readonly permission?: string;
+ permission?: string;
/** @enum {string} */
- readonly privacy?: "open" | "closed" | "secret";
+ privacy?: "open" | "closed" | "secret";
/** Format: uri */
- readonly repositories_url?: string;
- readonly slug?: string;
+ repositories_url?: string;
+ slug?: string;
/**
* Format: uri
* @description URL for the team
*/
- readonly url?: string;
+ url?: string;
}[];
/** Format: uri-template */
- readonly review_comment_url: string;
- readonly review_comments?: number;
+ review_comment_url: string;
+ review_comments?: number;
/** Format: uri */
- readonly review_comments_url: string;
+ review_comments_url: string;
/**
* @description State of this Pull Request. Either `open` or `closed`.
* @enum {string}
*/
- readonly state: "open" | "closed";
+ state: "open" | "closed";
/** Format: uri */
- readonly statuses_url: string;
+ statuses_url: string;
/** @description The title of the pull request. */
- readonly title: string;
+ title: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** User */
- readonly user: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** push event */
- readonly "webhook-push": {
+ "webhook-push": {
/** @description The SHA of the most recent commit on `ref` after the push. */
- readonly after: string;
- readonly base_ref: components["schemas"]["webhooks_nullable_string"];
+ after: string;
+ base_ref: components["schemas"]["webhooks_nullable_string"];
/** @description The SHA of the most recent commit on `ref` before the push. */
- readonly before: string;
+ before: string;
/** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */
- readonly commits: readonly {
+ commits: {
/** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */
- readonly added?: readonly string[];
+ added?: string[];
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/** @description Whether this commit is distinct from any that have been pushed before. */
- readonly distinct: boolean;
- readonly id: string;
+ distinct: boolean;
+ id: string;
/** @description The commit message. */
- readonly message: string;
+ message: string;
/** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */
- readonly modified?: readonly string[];
+ modified?: string[];
/** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */
- readonly removed?: readonly string[];
+ removed?: string[];
/**
* Format: date-time
* @description The ISO 8601 timestamp of the commit.
*/
- readonly timestamp: string;
- readonly tree_id: string;
+ timestamp: string;
+ tree_id: string;
/**
* Format: uri
* @description URL that points to the commit API resource.
*/
- readonly url: string;
+ url: string;
}[];
/** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */
- readonly compare: string;
+ compare: string;
/** @description Whether this push created the `ref`. */
- readonly created: boolean;
+ created: boolean;
/** @description Whether this push deleted the `ref`. */
- readonly deleted: boolean;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ deleted: boolean;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
/** @description Whether this push was a force push of the `ref`. */
- readonly forced: boolean;
+ forced: boolean;
/** Commit */
- readonly head_commit: {
+ head_commit: {
/** @description An array of files added in the commit. */
- readonly added?: readonly string[];
+ added?: string[];
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/** @description Whether this commit is distinct from any that have been pushed before. */
- readonly distinct: boolean;
- readonly id: string;
+ distinct: boolean;
+ id: string;
/** @description The commit message. */
- readonly message: string;
+ message: string;
/** @description An array of files modified by the commit. */
- readonly modified?: readonly string[];
+ modified?: string[];
/** @description An array of files removed in the commit. */
- readonly removed?: readonly string[];
+ removed?: string[];
/**
* Format: date-time
* @description The ISO 8601 timestamp of the commit.
*/
- readonly timestamp: string;
- readonly tree_id: string;
+ timestamp: string;
+ tree_id: string;
/**
* Format: uri
* @description URL that points to the commit API resource.
*/
- readonly url: string;
+ url: string;
} | null;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly pusher: {
+ pusher: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email?: string | null;
+ email?: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */
- readonly ref: string;
+ ref: string;
/**
* Repository
* @description A git repository
*/
- readonly repository: {
+ repository: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
+ has_wiki: boolean;
/**
* @description Whether discussions are enabled.
* @default false
*/
- readonly has_discussions: boolean;
- readonly homepage: string | null;
+ has_discussions: boolean;
+ /**
+ * @description Whether pull requests are enabled.
+ * @default true
+ */
+ has_pull_requests: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
/** @description Whether to require contributors to sign off on web-based commits */
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
- readonly sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user"];
};
- readonly "webhook-registry-package-published": {
+ "webhook-registry-package-published": {
/** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly registry_package: {
- readonly created_at: string | null;
- readonly description: string | null;
- readonly ecosystem: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- readonly owner: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- readonly user_view_type?: string;
- };
- readonly package_type: string;
- readonly package_version: {
- readonly author?: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- readonly user_view_type?: string;
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ registry_package: {
+ created_at: string | null;
+ description: string | null;
+ ecosystem: string;
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
+ owner: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ user_view_type?: string;
+ };
+ package_type: string;
+ package_version: {
+ author?: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ user_view_type?: string;
};
- readonly body?: string | Record;
- readonly body_html?: string;
- readonly container_metadata?: {
- readonly labels?: Record | null;
- readonly manifest?: Record | null;
- readonly tag?: {
- readonly digest?: string;
- readonly name?: string;
+ body?: string | Record;
+ body_html?: string;
+ container_metadata?: {
+ labels?: Record | null;
+ manifest?: Record | null;
+ tag?: {
+ digest?: string;
+ name?: string;
};
};
- readonly created_at?: string;
- readonly description: string;
- readonly docker_metadata?: readonly {
- readonly tags?: readonly string[];
+ created_at?: string;
+ description: string;
+ docker_metadata?: {
+ tags?: string[];
}[];
- readonly draft?: boolean;
- readonly html_url: string;
- readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: readonly {
- readonly [key: string]: unknown;
+ draft?: boolean;
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
}[];
- readonly name: string;
- readonly npm_metadata?: {
- readonly name?: string;
- readonly version?: string;
- readonly npm_user?: string;
- readonly author?: (string | Record) | null;
- readonly bugs?: (string | Record) | null;
- readonly dependencies?: Record;
- readonly dev_dependencies?: Record;
- readonly peer_dependencies?: Record;
- readonly optional_dependencies?: Record;
- readonly description?: string;
- readonly dist?: (string | Record) | null;
- readonly git_head?: string;
- readonly homepage?: string;
- readonly license?: string;
- readonly main?: string;
- readonly repository?: (string | Record) | null;
- readonly scripts?: Record;
- readonly id?: string;
- readonly node_version?: string;
- readonly npm_version?: string;
- readonly has_shrinkwrap?: boolean;
- readonly maintainers?: readonly string[];
- readonly contributors?: readonly string[];
- readonly engines?: Record;
- readonly keywords?: readonly string[];
- readonly files?: readonly string[];
- readonly bin?: Record;
- readonly man?: Record;
- readonly directories?: (string | Record) | null;
- readonly os?: readonly string[];
- readonly cpu?: readonly string[];
- readonly readme?: string;
- readonly installation_command?: string;
- readonly release_id?: number;
- readonly commit_oid?: string;
- readonly published_via_actions?: boolean;
- readonly deleted_by_id?: number;
+ name: string;
+ npm_metadata?: {
+ name?: string;
+ version?: string;
+ npm_user?: string;
+ author?: (string | Record) | null;
+ bugs?: (string | Record) | null;
+ dependencies?: Record;
+ dev_dependencies?: Record;
+ peer_dependencies?: Record;
+ optional_dependencies?: Record;
+ description?: string;
+ dist?: (string | Record) | null;
+ git_head?: string;
+ homepage?: string;
+ license?: string;
+ main?: string;
+ repository?: (string | Record) | null;
+ scripts?: Record;
+ id?: string;
+ node_version?: string;
+ npm_version?: string;
+ has_shrinkwrap?: boolean;
+ maintainers?: string[];
+ contributors?: string[];
+ engines?: Record;
+ keywords?: string[];
+ files?: string[];
+ bin?: Record;
+ man?: Record;
+ directories?: (string | Record) | null;
+ os?: string[];
+ cpu?: string[];
+ readme?: string;
+ installation_command?: string;
+ release_id?: number;
+ commit_oid?: string;
+ published_via_actions?: boolean;
+ deleted_by_id?: number;
} | null;
- readonly nuget_metadata?: readonly {
- readonly id?: (string | Record | number) | null;
- readonly name?: string;
- readonly value?: boolean | string | number | {
- readonly url?: string;
- readonly branch?: string;
- readonly commit?: string;
- readonly type?: string;
+ nuget_metadata?: {
+ id?: (string | Record | number) | null;
+ name?: string;
+ value?: boolean | string | number | {
+ url?: string;
+ branch?: string;
+ commit?: string;
+ type?: string;
};
}[] | null;
- readonly package_files: readonly {
- readonly content_type: string;
- readonly created_at: string;
- readonly download_url: string;
- readonly id: number;
- readonly md5: string | null;
- readonly name: string;
- readonly sha1: string | null;
- readonly sha256: string | null;
- readonly size: number;
- readonly state: string | null;
- readonly updated_at: string;
+ package_files: {
+ content_type: string;
+ created_at: string;
+ download_url: string;
+ id: number;
+ md5: string | null;
+ name: string;
+ sha1: string | null;
+ sha256: string | null;
+ size: number;
+ state: string | null;
+ updated_at: string;
}[];
- readonly package_url: string;
- readonly prerelease?: boolean;
- readonly release?: {
- readonly author?: {
- readonly avatar_url?: string;
- readonly events_url?: string;
- readonly followers_url?: string;
- readonly following_url?: string;
- readonly gists_url?: string;
- readonly gravatar_id?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly node_id?: string;
- readonly organizations_url?: string;
- readonly received_events_url?: string;
- readonly repos_url?: string;
- readonly site_admin?: boolean;
- readonly starred_url?: string;
- readonly subscriptions_url?: string;
- readonly type?: string;
- readonly url?: string;
- readonly user_view_type?: string;
+ package_url: string;
+ prerelease?: boolean;
+ release?: {
+ author?: {
+ avatar_url?: string;
+ events_url?: string;
+ followers_url?: string;
+ following_url?: string;
+ gists_url?: string;
+ gravatar_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ node_id?: string;
+ organizations_url?: string;
+ received_events_url?: string;
+ repos_url?: string;
+ site_admin?: boolean;
+ starred_url?: string;
+ subscriptions_url?: string;
+ type?: string;
+ url?: string;
+ user_view_type?: string;
};
- readonly created_at?: string;
- readonly draft?: boolean;
- readonly html_url?: string;
- readonly id?: number;
- readonly name?: string | null;
- readonly prerelease?: boolean;
- readonly published_at?: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly url?: string;
+ created_at?: string;
+ draft?: boolean;
+ html_url?: string;
+ id?: number;
+ name?: string | null;
+ prerelease?: boolean;
+ published_at?: string;
+ tag_name?: string;
+ target_commitish?: string;
+ url?: string;
};
- readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][];
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish?: string;
- readonly target_oid?: string;
- readonly updated_at?: string;
- readonly version: string;
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ summary: string;
+ tag_name?: string;
+ target_commitish?: string;
+ target_oid?: string;
+ updated_at?: string;
+ version: string;
} | null;
- readonly registry: {
- readonly about_url?: string;
- readonly name?: string;
- readonly type?: string;
- readonly url?: string;
- readonly vendor?: string;
+ registry: {
+ about_url?: string;
+ name?: string;
+ type?: string;
+ url?: string;
+ vendor?: string;
} | null;
- readonly updated_at: string | null;
+ updated_at: string | null;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
- readonly "webhook-registry-package-updated": {
+ "webhook-registry-package-updated": {
/** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly registry_package: {
- readonly created_at: string;
- readonly description: unknown;
- readonly ecosystem: string;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly namespace: string;
- readonly owner: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- readonly user_view_type?: string;
- };
- readonly package_type: string;
- readonly package_version: {
- readonly author: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- readonly user_view_type?: string;
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ registry_package: {
+ created_at: string;
+ description: unknown;
+ ecosystem: string;
+ html_url: string;
+ id: number;
+ name: string;
+ namespace: string;
+ owner: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ user_view_type?: string;
+ };
+ package_type: string;
+ package_version: {
+ author: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ user_view_type?: string;
};
- readonly body: string;
- readonly body_html: string;
- readonly created_at: string;
- readonly description: string;
- readonly docker_metadata?: readonly ({
- readonly tags?: readonly string[];
+ body: string;
+ body_html: string;
+ created_at: string;
+ description: string;
+ docker_metadata?: ({
+ tags?: string[];
} | null)[];
- readonly draft?: boolean;
- readonly html_url: string;
- readonly id: number;
- readonly installation_command: string;
- readonly manifest?: string;
- readonly metadata: readonly {
- readonly [key: string]: unknown;
+ draft?: boolean;
+ html_url: string;
+ id: number;
+ installation_command: string;
+ manifest?: string;
+ metadata: {
+ [key: string]: unknown;
}[];
- readonly name: string;
- readonly package_files: readonly {
- readonly content_type?: string;
- readonly created_at?: string;
- readonly download_url?: string;
- readonly id?: number;
- readonly md5?: string | null;
- readonly name?: string;
- readonly sha1?: string | null;
- readonly sha256?: string;
- readonly size?: number;
- readonly state?: string;
- readonly updated_at?: string;
+ name: string;
+ package_files: {
+ content_type?: string;
+ created_at?: string;
+ download_url?: string;
+ id?: number;
+ md5?: string | null;
+ name?: string;
+ sha1?: string | null;
+ sha256?: string;
+ size?: number;
+ state?: string;
+ updated_at?: string;
}[];
- readonly package_url: string;
- readonly prerelease?: boolean;
- readonly release?: {
- readonly author: {
- readonly avatar_url: string;
- readonly events_url: string;
- readonly followers_url: string;
- readonly following_url: string;
- readonly gists_url: string;
- readonly gravatar_id: string;
- readonly html_url: string;
- readonly id: number;
- readonly login: string;
- readonly node_id: string;
- readonly organizations_url: string;
- readonly received_events_url: string;
- readonly repos_url: string;
- readonly site_admin: boolean;
- readonly starred_url: string;
- readonly subscriptions_url: string;
- readonly type: string;
- readonly url: string;
- readonly user_view_type?: string;
+ package_url: string;
+ prerelease?: boolean;
+ release?: {
+ author: {
+ avatar_url: string;
+ events_url: string;
+ followers_url: string;
+ following_url: string;
+ gists_url: string;
+ gravatar_id: string;
+ html_url: string;
+ id: number;
+ login: string;
+ node_id: string;
+ organizations_url: string;
+ received_events_url: string;
+ repos_url: string;
+ site_admin: boolean;
+ starred_url: string;
+ subscriptions_url: string;
+ type: string;
+ url: string;
+ user_view_type?: string;
};
- readonly created_at: string;
- readonly draft: boolean;
- readonly html_url: string;
- readonly id: number;
- readonly name: string;
- readonly prerelease: boolean;
- readonly published_at: string;
- readonly tag_name: string;
- readonly target_commitish: string;
- readonly url: string;
+ created_at: string;
+ draft: boolean;
+ html_url: string;
+ id: number;
+ name: string;
+ prerelease: boolean;
+ published_at: string;
+ tag_name: string;
+ target_commitish: string;
+ url: string;
};
- readonly rubygems_metadata?: readonly components["schemas"]["webhook-rubygems-metadata"][];
- readonly summary: string;
- readonly tag_name?: string;
- readonly target_commitish: string;
- readonly target_oid: string;
- readonly updated_at: string;
- readonly version: string;
+ rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][];
+ summary: string;
+ tag_name?: string;
+ target_commitish: string;
+ target_oid: string;
+ updated_at: string;
+ version: string;
};
- readonly registry: Record | null;
- readonly updated_at: string;
+ registry: Record | null;
+ updated_at: string;
};
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** release created event */
- readonly "webhook-release-created": {
+ "webhook-release-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** release deleted event */
- readonly "webhook-release-deleted": {
+ "webhook-release-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** release edited event */
- readonly "webhook-release-edited": {
+ "webhook-release-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly body?: {
+ action: "edited";
+ changes: {
+ body?: {
/** @description The previous version of the body if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly name?: {
+ name?: {
/** @description The previous version of the name if the action was `edited`. */
- readonly from: string;
+ from: string;
+ };
+ tag_name?: {
+ /** @description The previous version of the tag_name if the action was `edited`. */
+ from: string;
};
- readonly make_latest?: {
+ make_latest?: {
/** @description Whether this release was explicitly `edited` to be the latest. */
- readonly to: boolean;
+ to: boolean;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** release prereleased event */
- readonly "webhook-release-prereleased": {
+ "webhook-release-prereleased": {
/** @enum {string} */
- readonly action: "prereleased";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
+ action: "prereleased";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
/**
* Release
* @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object.
*/
- readonly release: {
- readonly assets: readonly ({
+ release: {
+ assets: ({
/** Format: uri */
- readonly browser_download_url: string;
- readonly content_type: string;
+ browser_download_url: string;
+ content_type: string;
/** Format: date-time */
- readonly created_at: string;
- readonly download_count: number;
- readonly id: number;
- readonly label: string | null;
+ created_at: string;
+ download_count: number;
+ id: number;
+ label: string | null;
/** @description The file name of the asset. */
- readonly name: string;
- readonly node_id: string;
- readonly size: number;
+ name: string;
+ node_id: string;
+ size: number;
+ digest: string | null;
/**
* @description State of the release asset.
* @enum {string}
*/
- readonly state: "uploaded";
+ state: "uploaded";
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** User */
- readonly uploader?: {
+ uploader?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null)[];
/** Format: uri */
- readonly assets_url: string;
+ assets_url: string;
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly body: string | null;
+ body: string | null;
/** Format: date-time */
- readonly created_at: string | null;
+ created_at: string | null;
/** Format: uri */
- readonly discussion_url?: string;
+ discussion_url?: string;
/** @description Whether the release is a draft or published */
- readonly draft: boolean;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly name: string | null;
- readonly node_id: string;
+ draft: boolean;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ /** @description Whether or not the release is immutable. */
+ immutable: boolean;
+ name: string | null;
+ node_id: string;
/**
* @description Whether the release is identified as a prerelease or a full release.
* @enum {boolean}
*/
- readonly prerelease: true;
+ prerelease: true;
/** Format: date-time */
- readonly published_at: string | null;
+ published_at: string | null;
/** Reactions */
- readonly reactions?: {
- readonly "+1": number;
- readonly "-1": number;
- readonly confused: number;
- readonly eyes: number;
- readonly heart: number;
- readonly hooray: number;
- readonly laugh: number;
- readonly rocket: number;
- readonly total_count: number;
- /** Format: uri */
- readonly url: string;
+ reactions?: {
+ "+1": number;
+ "-1": number;
+ confused: number;
+ eyes: number;
+ heart: number;
+ hooray: number;
+ laugh: number;
+ rocket: number;
+ total_count: number;
+ /** Format: uri */
+ url: string;
};
/** @description The name of the tag. */
- readonly tag_name: string;
+ tag_name: string;
/** Format: uri */
- readonly tarball_url: string | null;
+ tarball_url: string | null;
/** @description Specifies the commitish value that determines where the Git tag is created from. */
- readonly target_commitish: string;
+ target_commitish: string;
/** Format: uri-template */
- readonly upload_url: string;
+ upload_url: string;
+ /** Format: date-time */
+ updated_at: string | null;
/** Format: uri */
- readonly url: string;
+ url: string;
/** Format: uri */
- readonly zipball_url: string | null;
+ zipball_url: string | null;
};
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** release published event */
- readonly "webhook-release-published": {
+ "webhook-release-published": {
/** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release_1"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release_1"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** release released event */
- readonly "webhook-release-released": {
+ "webhook-release-released": {
/** @enum {string} */
- readonly action: "released";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "released";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** release unpublished event */
- readonly "webhook-release-unpublished": {
+ "webhook-release-unpublished": {
/** @enum {string} */
- readonly action: "unpublished";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly release: components["schemas"]["webhooks_release_1"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "unpublished";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ release: components["schemas"]["webhooks_release_1"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** Repository advisory published event */
- readonly "webhook-repository-advisory-published": {
+ "webhook-repository-advisory-published": {
/** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly repository_advisory: components["schemas"]["repository-advisory"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ repository_advisory: components["schemas"]["repository-advisory"];
+ sender?: components["schemas"]["simple-user"];
};
/** Repository advisory reported event */
- readonly "webhook-repository-advisory-reported": {
+ "webhook-repository-advisory-reported": {
/** @enum {string} */
- readonly action: "reported";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly repository_advisory: components["schemas"]["repository-advisory"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "reported";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ repository_advisory: components["schemas"]["repository-advisory"];
+ sender?: components["schemas"]["simple-user"];
};
/** repository archived event */
- readonly "webhook-repository-archived": {
+ "webhook-repository-archived": {
/** @enum {string} */
- readonly action: "archived";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "archived";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository created event */
- readonly "webhook-repository-created": {
+ "webhook-repository-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository deleted event */
- readonly "webhook-repository-deleted": {
+ "webhook-repository-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_dispatch event */
- readonly "webhook-repository-dispatch-sample": {
+ "webhook-repository-dispatch-sample": {
/** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */
- readonly action: string;
- readonly branch: string;
+ action: string;
+ branch: string;
/** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */
- readonly client_payload: {
- readonly [key: string]: unknown;
+ client_payload: {
+ [key: string]: unknown;
} | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository edited event */
- readonly "webhook-repository-edited": {
+ "webhook-repository-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly default_branch?: {
- readonly from: string;
+ action: "edited";
+ changes: {
+ default_branch?: {
+ from: string;
};
- readonly description?: {
- readonly from: string | null;
+ description?: {
+ from: string | null;
};
- readonly homepage?: {
- readonly from: string | null;
+ homepage?: {
+ from: string | null;
};
- readonly topics?: {
- readonly from?: readonly string[] | null;
+ topics?: {
+ from?: string[] | null;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_import event */
- readonly "webhook-repository-import": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ "webhook-repository-import": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
/** @enum {string} */
- readonly status: "success" | "cancelled" | "failure";
+ status: "success" | "cancelled" | "failure";
};
/** repository privatized event */
- readonly "webhook-repository-privatized": {
+ "webhook-repository-privatized": {
/** @enum {string} */
- readonly action: "privatized";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "privatized";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository publicized event */
- readonly "webhook-repository-publicized": {
+ "webhook-repository-publicized": {
/** @enum {string} */
- readonly action: "publicized";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "publicized";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository renamed event */
- readonly "webhook-repository-renamed": {
+ "webhook-repository-renamed": {
/** @enum {string} */
- readonly action: "renamed";
- readonly changes: {
- readonly repository: {
- readonly name: {
- readonly from: string;
+ action: "renamed";
+ changes: {
+ repository: {
+ name: {
+ from: string;
};
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository ruleset created event */
- readonly "webhook-repository-ruleset-created": {
+ "webhook-repository-ruleset-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ sender: components["schemas"]["simple-user"];
};
/** repository ruleset deleted event */
- readonly "webhook-repository-ruleset-deleted": {
+ "webhook-repository-ruleset-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ sender: components["schemas"]["simple-user"];
};
/** repository ruleset edited event */
- readonly "webhook-repository-ruleset-edited": {
+ "webhook-repository-ruleset-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly repository_ruleset: components["schemas"]["repository-ruleset"];
- readonly changes?: {
- readonly name?: {
- readonly from?: string;
- };
- readonly enforcement?: {
- readonly from?: string;
- };
- readonly conditions?: {
- readonly added?: readonly components["schemas"]["repository-ruleset-conditions"][];
- readonly deleted?: readonly components["schemas"]["repository-ruleset-conditions"][];
- readonly updated?: readonly {
- readonly condition?: components["schemas"]["repository-ruleset-conditions"];
- readonly changes?: {
- readonly condition_type?: {
- readonly from?: string;
+ action: "edited";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ repository_ruleset: components["schemas"]["repository-ruleset"];
+ changes?: {
+ name?: {
+ from?: string;
+ };
+ enforcement?: {
+ from?: string;
+ };
+ conditions?: {
+ added?: components["schemas"]["repository-ruleset-conditions"][];
+ deleted?: components["schemas"]["repository-ruleset-conditions"][];
+ updated?: {
+ condition?: components["schemas"]["repository-ruleset-conditions"];
+ changes?: {
+ condition_type?: {
+ from?: string;
};
- readonly target?: {
- readonly from?: string;
+ target?: {
+ from?: string;
};
- readonly include?: {
- readonly from?: readonly string[];
+ include?: {
+ from?: string[];
};
- readonly exclude?: {
- readonly from?: readonly string[];
+ exclude?: {
+ from?: string[];
};
};
}[];
};
- readonly rules?: {
- readonly added?: readonly components["schemas"]["repository-rule"][];
- readonly deleted?: readonly components["schemas"]["repository-rule"][];
- readonly updated?: readonly {
- readonly rule?: components["schemas"]["repository-rule"];
- readonly changes?: {
- readonly configuration?: {
- readonly from?: string;
+ rules?: {
+ added?: components["schemas"]["repository-rule"][];
+ deleted?: components["schemas"]["repository-rule"][];
+ updated?: {
+ rule?: components["schemas"]["repository-rule"];
+ changes?: {
+ configuration?: {
+ from?: string;
};
- readonly rule_type?: {
- readonly from?: string;
+ rule_type?: {
+ from?: string;
};
- readonly pattern?: {
- readonly from?: string;
+ pattern?: {
+ from?: string;
};
};
}[];
};
};
- readonly sender: components["schemas"]["simple-user"];
+ sender: components["schemas"]["simple-user"];
};
/** repository transferred event */
- readonly "webhook-repository-transferred": {
+ "webhook-repository-transferred": {
/** @enum {string} */
- readonly action: "transferred";
- readonly changes: {
- readonly owner: {
- readonly from: {
+ action: "transferred";
+ changes: {
+ owner: {
+ from: {
/** Organization */
- readonly organization?: {
+ organization?: {
/** Format: uri */
- readonly avatar_url: string;
- readonly description: string | null;
+ avatar_url: string;
+ description: string | null;
/** Format: uri */
- readonly events_url: string;
+ events_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
+ html_url?: string;
+ id: number;
/** Format: uri */
- readonly issues_url: string;
- readonly login: string;
+ issues_url: string;
+ login: string;
/** Format: uri-template */
- readonly members_url: string;
- readonly node_id: string;
+ members_url: string;
+ node_id: string;
/** Format: uri-template */
- readonly public_members_url: string;
+ public_members_url: string;
/** Format: uri */
- readonly repos_url: string;
+ repos_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** User */
- readonly user?: {
+ user?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
+ html_url?: string;
/** Format: int64 */
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
};
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository unarchived event */
- readonly "webhook-repository-unarchived": {
+ "webhook-repository-unarchived": {
/** @enum {string} */
- readonly action: "unarchived";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "unarchived";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_vulnerability_alert create event */
- readonly "webhook-repository-vulnerability-alert-create": {
+ "webhook-repository-vulnerability-alert-create": {
/** @enum {string} */
- readonly action: "create";
- readonly alert: components["schemas"]["webhooks_alert"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "create";
+ alert: components["schemas"]["webhooks_alert"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_vulnerability_alert dismiss event */
- readonly "webhook-repository-vulnerability-alert-dismiss": {
+ "webhook-repository-vulnerability-alert-dismiss": {
/** @enum {string} */
- readonly action: "dismiss";
+ action: "dismiss";
/**
* Repository Vulnerability Alert Alert
* @description The security alert of the vulnerable dependency.
*/
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_comment?: string | null;
- readonly dismiss_reason: string;
- readonly dismissed_at: string;
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_comment?: string | null;
+ dismiss_reason: string;
+ dismissed_at: string;
/** User */
- readonly dismisser: {
+ dismisser: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly external_identifier: string;
+ external_identifier: string;
/** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
+ external_reference: string | null;
+ fix_reason?: string;
/** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
/** @enum {string} */
- readonly state: "dismissed";
+ state: "dismissed";
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_vulnerability_alert reopen event */
- readonly "webhook-repository-vulnerability-alert-reopen": {
+ "webhook-repository-vulnerability-alert-reopen": {
/** @enum {string} */
- readonly action: "reopen";
- readonly alert: components["schemas"]["webhooks_alert"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "reopen";
+ alert: components["schemas"]["webhooks_alert"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** repository_vulnerability_alert resolve event */
- readonly "webhook-repository-vulnerability-alert-resolve": {
+ "webhook-repository-vulnerability-alert-resolve": {
/** @enum {string} */
- readonly action: "resolve";
+ action: "resolve";
/**
* Repository Vulnerability Alert Alert
* @description The security alert of the vulnerable dependency.
*/
- readonly alert: {
- readonly affected_package_name: string;
- readonly affected_range: string;
- readonly created_at: string;
- readonly dismiss_reason?: string;
- readonly dismissed_at?: string;
+ alert: {
+ affected_package_name: string;
+ affected_range: string;
+ created_at: string;
+ dismiss_reason?: string;
+ dismissed_at?: string;
/** User */
- readonly dismisser?: {
+ dismisser?: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
- readonly external_identifier: string;
+ external_identifier: string;
/** Format: uri */
- readonly external_reference: string | null;
- readonly fix_reason?: string;
+ external_reference: string | null;
+ fix_reason?: string;
/** Format: date-time */
- readonly fixed_at?: string;
- readonly fixed_in?: string;
- readonly ghsa_id: string;
- readonly id: number;
- readonly node_id: string;
- readonly number: number;
- readonly severity: string;
+ fixed_at?: string;
+ fixed_in?: string;
+ ghsa_id: string;
+ id: number;
+ node_id: string;
+ number: number;
+ severity: string;
/** @enum {string} */
- readonly state: "fixed" | "open";
+ state: "fixed" | "open";
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ };
+ /** secret_scanning_alert assigned event */
+ "webhook-secret-scanning-alert-assigned": {
+ /** @enum {string} */
+ action: "assigned";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ assignee?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** secret_scanning_alert created event */
- readonly "webhook-secret-scanning-alert-created": {
+ "webhook-secret-scanning-alert-created": {
/** @enum {string} */
- readonly action: "created";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "created";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** Secret Scanning Alert Location Created Event */
- readonly "webhook-secret-scanning-alert-location-created": {
+ "webhook-secret-scanning-alert-location-created": {
/** @enum {string} */
- readonly action?: "created";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly location: components["schemas"]["secret-scanning-location"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action?: "created";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ installation?: components["schemas"]["simple-installation"];
+ location: components["schemas"]["secret-scanning-location"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** Secret Scanning Alert Location Created Event */
- readonly "webhook-secret-scanning-alert-location-created-form-encoded": {
+ "webhook-secret-scanning-alert-location-created-form-encoded": {
/** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */
- readonly payload: string;
+ payload: string;
};
/** secret_scanning_alert publicly leaked event */
- readonly "webhook-secret-scanning-alert-publicly-leaked": {
+ "webhook-secret-scanning-alert-publicly-leaked": {
/** @enum {string} */
- readonly action: "publicly_leaked";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "publicly_leaked";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** secret_scanning_alert reopened event */
- readonly "webhook-secret-scanning-alert-reopened": {
+ "webhook-secret-scanning-alert-reopened": {
/** @enum {string} */
- readonly action: "reopened";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "reopened";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** secret_scanning_alert resolved event */
- readonly "webhook-secret-scanning-alert-resolved": {
+ "webhook-secret-scanning-alert-resolved": {
+ /** @enum {string} */
+ action: "resolved";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
+ };
+ /** secret_scanning_alert unassigned event */
+ "webhook-secret-scanning-alert-unassigned": {
/** @enum {string} */
- readonly action: "resolved";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "unassigned";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ assignee?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** secret_scanning_alert validated event */
- readonly "webhook-secret-scanning-alert-validated": {
+ "webhook-secret-scanning-alert-validated": {
/** @enum {string} */
- readonly action: "validated";
- readonly alert: components["schemas"]["secret-scanning-alert-webhook"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "validated";
+ alert: components["schemas"]["secret-scanning-alert-webhook"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** secret_scanning_scan completed event */
- readonly "webhook-secret-scanning-scan-completed": {
+ "webhook-secret-scanning-scan-completed": {
/** @enum {string} */
- readonly action: "completed";
+ action: "completed";
/**
* @description What type of scan was completed
* @enum {string}
*/
- readonly type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill";
+ type: "backfill" | "custom-pattern-backfill" | "pattern-version-backfill";
/**
* @description What type of content was scanned
* @enum {string}
*/
- readonly source: "git" | "issues" | "pull-requests" | "discussions" | "wiki";
+ source: "git" | "issues" | "pull-requests" | "discussions" | "wiki";
/**
* Format: date-time
* @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly started_at: string;
+ started_at: string;
/**
* Format: date-time
* @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly completed_at: string;
+ completed_at: string;
/** @description List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates */
- readonly secret_types?: readonly string[] | null;
+ secret_types?: string[] | null;
/** @description If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated */
- readonly custom_pattern_name?: string | null;
+ custom_pattern_name?: string | null;
/**
* @description If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated
* @enum {string|null}
*/
- readonly custom_pattern_scope?: "repository" | "organization" | "enterprise" | null;
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ custom_pattern_scope?: "repository" | "organization" | "enterprise" | null;
+ repository?: components["schemas"]["repository-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** security_advisory published event */
- readonly "webhook-security-advisory-published": {
+ "webhook-security-advisory-published": {
/** @enum {string} */
- readonly action: "published";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly security_advisory: components["schemas"]["webhooks_security_advisory"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "published";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ security_advisory: components["schemas"]["webhooks_security_advisory"];
+ sender?: components["schemas"]["simple-user"];
};
/** security_advisory updated event */
- readonly "webhook-security-advisory-updated": {
+ "webhook-security-advisory-updated": {
/** @enum {string} */
- readonly action: "updated";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly security_advisory: components["schemas"]["webhooks_security_advisory"];
- readonly sender?: components["schemas"]["simple-user"];
+ action: "updated";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ security_advisory: components["schemas"]["webhooks_security_advisory"];
+ sender?: components["schemas"]["simple-user"];
};
/** security_advisory withdrawn event */
- readonly "webhook-security-advisory-withdrawn": {
+ "webhook-security-advisory-withdrawn": {
/** @enum {string} */
- readonly action: "withdrawn";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
+ action: "withdrawn";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
/** @description The details of the security advisory, including summary, description, and severity. */
- readonly security_advisory: {
- readonly cvss: {
- readonly score: number;
- readonly vector_string: string | null;
- };
- readonly cvss_severities?: components["schemas"]["cvss-severities"];
- readonly cwes: readonly {
- readonly cwe_id: string;
- readonly name: string;
+ security_advisory: {
+ cvss: {
+ score: number;
+ vector_string: string | null;
+ };
+ cvss_severities?: components["schemas"]["cvss-severities"];
+ cwes: {
+ cwe_id: string;
+ name: string;
}[];
- readonly description: string;
- readonly ghsa_id: string;
- readonly identifiers: readonly {
- readonly type: string;
- readonly value: string;
+ description: string;
+ ghsa_id: string;
+ identifiers: {
+ type: string;
+ value: string;
}[];
- readonly published_at: string;
- readonly references: readonly {
+ published_at: string;
+ references: {
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly severity: string;
- readonly summary: string;
- readonly updated_at: string;
- readonly vulnerabilities: readonly {
- readonly first_patched_version: {
- readonly identifier: string;
+ severity: string;
+ summary: string;
+ updated_at: string;
+ vulnerabilities: {
+ first_patched_version: {
+ identifier: string;
} | null;
- readonly package: {
- readonly ecosystem: string;
- readonly name: string;
+ package: {
+ ecosystem: string;
+ name: string;
};
- readonly severity: string;
- readonly vulnerable_version_range: string;
+ severity: string;
+ vulnerable_version_range: string;
}[];
- readonly withdrawn_at: string;
+ withdrawn_at: string;
};
- readonly sender?: components["schemas"]["simple-user"];
+ sender?: components["schemas"]["simple-user"];
};
/** security_and_analysis event */
- readonly "webhook-security-and-analysis": {
- readonly changes: {
- readonly from?: {
- readonly security_and_analysis?: components["schemas"]["security-and-analysis"];
+ "webhook-security-and-analysis": {
+ changes: {
+ from?: {
+ security_and_analysis?: components["schemas"]["security-and-analysis"];
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["full-repository"];
- readonly sender?: components["schemas"]["simple-user"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["full-repository"];
+ sender?: components["schemas"]["simple-user"];
};
/** sponsorship cancelled event */
- readonly "webhook-sponsorship-cancelled": {
+ "webhook-sponsorship-cancelled": {
/** @enum {string} */
- readonly action: "cancelled";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ action: "cancelled";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** sponsorship created event */
- readonly "webhook-sponsorship-created": {
+ "webhook-sponsorship-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** sponsorship edited event */
- readonly "webhook-sponsorship-edited": {
+ "webhook-sponsorship-edited": {
/** @enum {string} */
- readonly action: "edited";
- readonly changes: {
- readonly privacy_level?: {
+ action: "edited";
+ changes: {
+ privacy_level?: {
/** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */
- readonly from: string;
+ from: string;
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** sponsorship pending_cancellation event */
- readonly "webhook-sponsorship-pending-cancellation": {
+ "webhook-sponsorship-pending-cancellation": {
/** @enum {string} */
- readonly action: "pending_cancellation";
- readonly effective_date?: components["schemas"]["webhooks_effective_date"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ action: "pending_cancellation";
+ effective_date?: components["schemas"]["webhooks_effective_date"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** sponsorship pending_tier_change event */
- readonly "webhook-sponsorship-pending-tier-change": {
+ "webhook-sponsorship-pending-tier-change": {
/** @enum {string} */
- readonly action: "pending_tier_change";
- readonly changes: components["schemas"]["webhooks_changes_8"];
- readonly effective_date?: components["schemas"]["webhooks_effective_date"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ action: "pending_tier_change";
+ changes: components["schemas"]["webhooks_changes_8"];
+ effective_date?: components["schemas"]["webhooks_effective_date"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** sponsorship tier_changed event */
- readonly "webhook-sponsorship-tier-changed": {
+ "webhook-sponsorship-tier-changed": {
/** @enum {string} */
- readonly action: "tier_changed";
- readonly changes: components["schemas"]["webhooks_changes_8"];
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly sponsorship: components["schemas"]["webhooks_sponsorship"];
+ action: "tier_changed";
+ changes: components["schemas"]["webhooks_changes_8"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ sponsorship: components["schemas"]["webhooks_sponsorship"];
};
/** star created event */
- readonly "webhook-star-created": {
+ "webhook-star-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
/** @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. */
- readonly starred_at: string | null;
+ starred_at: string | null;
};
/** star deleted event */
- readonly "webhook-star-deleted": {
+ "webhook-star-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
/** @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. */
- readonly starred_at: unknown;
+ starred_at: unknown;
};
/** status event */
- readonly "webhook-status": {
+ "webhook-status": {
/** Format: uri */
- readonly avatar_url?: string | null;
+ avatar_url?: string | null;
/** @description An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. */
- readonly branches: readonly {
- readonly commit: {
- readonly sha: string | null;
+ branches: {
+ commit: {
+ sha: string | null;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
};
- readonly name: string;
- readonly protected: boolean;
+ name: string;
+ protected: boolean;
}[];
- readonly commit: {
+ commit: {
/** User */
- readonly author: {
+ author: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly comments_url: string;
- readonly commit: {
- readonly author: {
+ comments_url: string;
+ commit: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
} & {
- readonly date: string;
- readonly email?: string;
- readonly name?: string;
+ date: string;
+ email?: string;
+ name?: string;
};
- readonly comment_count: number;
- readonly committer: {
+ comment_count: number;
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
} & {
- readonly date: string;
- readonly email?: string;
- readonly name?: string;
+ date: string;
+ email?: string;
+ name?: string;
};
- readonly message: string;
- readonly tree: {
- readonly sha: string;
+ message: string;
+ tree: {
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Format: uri */
- readonly url: string;
- readonly verification: {
- readonly payload: string | null;
+ url: string;
+ verification: {
+ payload: string | null;
/** @enum {string} */
- readonly reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending";
- readonly signature: string | null;
- readonly verified: boolean;
- readonly verified_at?: string | null;
+ reason: "expired_key" | "not_signing_key" | "gpgverify_error" | "gpgverify_unavailable" | "unsigned" | "unknown_signature_type" | "no_user" | "unverified_email" | "bad_email" | "unknown_key" | "malformed_signature" | "invalid" | "valid" | "bad_cert" | "ocsp_pending";
+ signature: string | null;
+ verified: boolean;
+ verified_at: string | null;
};
};
/** User */
- readonly committer: {
+ committer: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id?: number;
- readonly login?: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id?: number;
+ login?: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly html_url: string;
- readonly node_id: string;
- readonly parents: readonly {
+ html_url: string;
+ node_id: string;
+ parents: {
/** Format: uri */
- readonly html_url: string;
- readonly sha: string;
+ html_url: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly sha: string;
+ sha: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly context: string;
- readonly created_at: string;
+ context: string;
+ created_at: string;
/** @description The optional human-readable description added to the status. */
- readonly description: string | null;
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
+ description: string | null;
+ enterprise?: components["schemas"]["enterprise-webhooks"];
/** @description The unique identifier of the status. */
- readonly id: number;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly name: string;
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ id: number;
+ installation?: components["schemas"]["simple-installation"];
+ name: string;
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
/** @description The Commit SHA. */
- readonly sha: string;
+ sha: string;
/**
* @description The new state. Can be `pending`, `success`, `failure`, or `error`.
* @enum {string}
*/
- readonly state: "pending" | "success" | "failure" | "error";
+ state: "pending" | "success" | "failure" | "error";
/** @description The optional link added to the status. */
- readonly target_url: string | null;
- readonly updated_at: string;
+ target_url: string | null;
+ updated_at: string;
};
/** parent issue added event */
- readonly "webhook-sub-issues-parent-issue-added": {
+ "webhook-sub-issues-parent-issue-added": {
/** @enum {string} */
- readonly action: "parent_issue_added";
+ action: "parent_issue_added";
/** @description The ID of the parent issue. */
- readonly parent_issue_id: number;
- readonly parent_issue: components["schemas"]["issue"];
- readonly parent_issue_repo: components["schemas"]["repository"];
+ parent_issue_id: number;
+ parent_issue: components["schemas"]["issue"];
+ parent_issue_repo: components["schemas"]["repository"];
/** @description The ID of the sub-issue. */
- readonly sub_issue_id: number;
- readonly sub_issue: components["schemas"]["issue"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ sub_issue_id: number;
+ sub_issue: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** parent issue removed event */
- readonly "webhook-sub-issues-parent-issue-removed": {
+ "webhook-sub-issues-parent-issue-removed": {
/** @enum {string} */
- readonly action: "parent_issue_removed";
+ action: "parent_issue_removed";
/** @description The ID of the parent issue. */
- readonly parent_issue_id: number;
- readonly parent_issue: components["schemas"]["issue"];
- readonly parent_issue_repo: components["schemas"]["repository"];
+ parent_issue_id: number;
+ parent_issue: components["schemas"]["issue"];
+ parent_issue_repo: components["schemas"]["repository"];
/** @description The ID of the sub-issue. */
- readonly sub_issue_id: number;
- readonly sub_issue: components["schemas"]["issue"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ sub_issue_id: number;
+ sub_issue: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** sub-issue added event */
- readonly "webhook-sub-issues-sub-issue-added": {
+ "webhook-sub-issues-sub-issue-added": {
/** @enum {string} */
- readonly action: "sub_issue_added";
+ action: "sub_issue_added";
/** @description The ID of the sub-issue. */
- readonly sub_issue_id: number;
- readonly sub_issue: components["schemas"]["issue"];
- readonly sub_issue_repo: components["schemas"]["repository"];
+ sub_issue_id: number;
+ sub_issue: components["schemas"]["issue"];
+ sub_issue_repo: components["schemas"]["repository"];
/** @description The ID of the parent issue. */
- readonly parent_issue_id: number;
- readonly parent_issue: components["schemas"]["issue"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ parent_issue_id: number;
+ parent_issue: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** sub-issue removed event */
- readonly "webhook-sub-issues-sub-issue-removed": {
+ "webhook-sub-issues-sub-issue-removed": {
/** @enum {string} */
- readonly action: "sub_issue_removed";
+ action: "sub_issue_removed";
/** @description The ID of the sub-issue. */
- readonly sub_issue_id: number;
- readonly sub_issue: components["schemas"]["issue"];
- readonly sub_issue_repo: components["schemas"]["repository"];
+ sub_issue_id: number;
+ sub_issue: components["schemas"]["issue"];
+ sub_issue_repo: components["schemas"]["repository"];
/** @description The ID of the parent issue. */
- readonly parent_issue_id: number;
- readonly parent_issue: components["schemas"]["issue"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository?: components["schemas"]["repository-webhooks"];
- readonly sender?: components["schemas"]["simple-user"];
+ parent_issue_id: number;
+ parent_issue: components["schemas"]["issue"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository?: components["schemas"]["repository-webhooks"];
+ sender?: components["schemas"]["simple-user"];
};
/** team_add event */
- readonly "webhook-team-add": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ "webhook-team-add": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** team added_to_repository event */
- readonly "webhook-team-added-to-repository": {
+ "webhook-team-added-to-repository": {
/** @enum {string} */
- readonly action: "added_to_repository";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ action: "added_to_repository";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
*/
- readonly repository?: {
+ repository?: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sender?: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ sender?: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** team created event */
- readonly "webhook-team-created": {
+ "webhook-team-created": {
/** @enum {string} */
- readonly action: "created";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ action: "created";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
*/
- readonly repository?: {
+ repository?: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sender: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ sender: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** team deleted event */
- readonly "webhook-team-deleted": {
+ "webhook-team-deleted": {
/** @enum {string} */
- readonly action: "deleted";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ action: "deleted";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
*/
- readonly repository?: {
+ repository?: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sender?: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ sender?: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** team edited event */
- readonly "webhook-team-edited": {
+ "webhook-team-edited": {
/** @enum {string} */
- readonly action: "edited";
+ action: "edited";
/** @description The changes to the team if the action was `edited`. */
- readonly changes: {
- readonly description?: {
+ changes: {
+ description?: {
/** @description The previous version of the description if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly name?: {
+ name?: {
/** @description The previous version of the name if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly privacy?: {
+ privacy?: {
/** @description The previous version of the team's privacy if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly notification_setting?: {
+ notification_setting?: {
/** @description The previous version of the team's notification setting if the action was `edited`. */
- readonly from: string;
+ from: string;
};
- readonly repository?: {
- readonly permissions: {
- readonly from: {
+ repository?: {
+ permissions: {
+ from: {
/** @description The previous version of the team member's `admin` permission on a repository, if the action was `edited`. */
- readonly admin?: boolean;
+ admin?: boolean;
/** @description The previous version of the team member's `pull` permission on a repository, if the action was `edited`. */
- readonly pull?: boolean;
+ pull?: boolean;
/** @description The previous version of the team member's `push` permission on a repository, if the action was `edited`. */
- readonly push?: boolean;
+ push?: boolean;
};
};
};
};
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
*/
- readonly repository?: {
+ repository?: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sender: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ sender: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** team removed_from_repository event */
- readonly "webhook-team-removed-from-repository": {
+ "webhook-team-removed-from-repository": {
/** @enum {string} */
- readonly action: "removed_from_repository";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization: components["schemas"]["organization-simple-webhooks"];
+ action: "removed_from_repository";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization: components["schemas"]["organization-simple-webhooks"];
/**
* Repository
* @description A git repository
*/
- readonly repository?: {
+ repository?: {
/**
* @description Whether to allow auto-merge for pull requests.
* @default false
*/
- readonly allow_auto_merge: boolean;
+ allow_auto_merge: boolean;
/** @description Whether to allow private forks */
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Whether to allow merge commits for pull requests.
* @default true
*/
- readonly allow_merge_commit: boolean;
+ allow_merge_commit: boolean;
/**
* @description Whether to allow rebase merges for pull requests.
* @default true
*/
- readonly allow_rebase_merge: boolean;
+ allow_rebase_merge: boolean;
/**
* @description Whether to allow squash merges for pull requests.
* @default true
*/
- readonly allow_squash_merge: boolean;
- readonly allow_update_branch?: boolean;
+ allow_squash_merge: boolean;
+ allow_update_branch?: boolean;
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/**
* @description Whether the repository is archived.
* @default false
*/
- readonly archived: boolean;
+ archived: boolean;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri */
- readonly clone_url: string;
+ clone_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
- readonly created_at: number | string;
+ contributors_url: string;
+ created_at: number | string;
/** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
/** @description The default branch of the repository. */
- readonly default_branch: string;
+ default_branch: string;
/**
* @description Whether to delete head branches when pull requests are merged
* @default false
*/
- readonly delete_branch_on_merge: boolean;
+ delete_branch_on_merge: boolean;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** @description Returns whether or not this repository is disabled. */
- readonly disabled?: boolean;
+ disabled?: boolean;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
- readonly forks: number;
- readonly forks_count: number;
+ events_url: string;
+ fork: boolean;
+ forks: number;
+ forks_count: number;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly git_url: string;
+ git_url: string;
/**
* @description Whether downloads are enabled.
* @default true
*/
- readonly has_downloads: boolean;
+ has_downloads: boolean;
/**
* @description Whether issues are enabled.
* @default true
*/
- readonly has_issues: boolean;
- readonly has_pages: boolean;
+ has_issues: boolean;
+ has_pages: boolean;
/**
* @description Whether projects are enabled.
* @default true
*/
- readonly has_projects: boolean;
+ has_projects: boolean;
/**
* @description Whether the wiki is enabled.
* @default true
*/
- readonly has_wiki: boolean;
- readonly homepage: string | null;
+ has_wiki: boolean;
+ homepage: string | null;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/**
* Format: int64
* @description Unique identifier of the repository
*/
- readonly id: number;
- readonly is_template?: boolean;
+ id: number;
+ is_template?: boolean;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
- readonly language: string | null;
+ labels_url: string;
+ language: string | null;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** License */
- readonly license: {
- readonly key: string;
- readonly name: string;
- readonly node_id: string;
- readonly spdx_id: string;
+ license: {
+ key: string;
+ name: string;
+ node_id: string;
+ spdx_id: string;
/** Format: uri */
- readonly url: string | null;
+ url: string | null;
} | null;
- readonly master_branch?: string;
+ master_branch?: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** Format: uri */
- readonly mirror_url: string | null;
+ mirror_url: string | null;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
- readonly open_issues: number;
- readonly open_issues_count: number;
- readonly organization?: string;
+ notifications_url: string;
+ open_issues: number;
+ open_issues_count: number;
+ organization?: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
- readonly permissions?: {
- readonly admin: boolean;
- readonly maintain?: boolean;
- readonly pull: boolean;
- readonly push: boolean;
- readonly triage?: boolean;
+ permissions?: {
+ admin: boolean;
+ maintain?: boolean;
+ pull: boolean;
+ push: boolean;
+ triage?: boolean;
};
/** @description Whether the repository is private or public. */
- readonly private: boolean;
- readonly public?: boolean;
+ private: boolean;
+ public?: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
- readonly pushed_at: (number | string) | null;
+ pulls_url: string;
+ pushed_at: (number | string) | null;
/** Format: uri-template */
- readonly releases_url: string;
- readonly role_name?: string | null;
- readonly size: number;
- readonly ssh_url: string;
- readonly stargazers?: number;
- readonly stargazers_count: number;
- /** Format: uri */
- readonly stargazers_url: string;
+ releases_url: string;
+ role_name?: string | null;
+ size: number;
+ ssh_url: string;
+ stargazers?: number;
+ stargazers_count: number;
+ /** Format: uri */
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly svn_url: string;
+ svn_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
- readonly topics: readonly string[];
+ teams_url: string;
+ topics: string[];
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
+ url: string;
/** @enum {string} */
- readonly visibility: "public" | "private" | "internal";
- readonly watchers: number;
- readonly watchers_count: number;
+ visibility: "public" | "private" | "internal";
+ watchers: number;
+ watchers_count: number;
};
- readonly sender: components["schemas"]["simple-user"];
- readonly team: components["schemas"]["webhooks_team_1"];
+ sender: components["schemas"]["simple-user"];
+ team: components["schemas"]["webhooks_team_1"];
};
/** watch started event */
- readonly "webhook-watch-started": {
+ "webhook-watch-started": {
/** @enum {string} */
- readonly action: "started";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
+ action: "started";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
};
/** workflow_dispatch event */
- readonly "webhook-workflow-dispatch": {
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly inputs: {
- readonly [key: string]: unknown;
+ "webhook-workflow-dispatch": {
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ inputs: {
+ [key: string]: unknown;
} | null;
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly ref: string;
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow: string;
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ ref: string;
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow: string;
};
/** workflow_job completed event */
- readonly "webhook-workflow-job-completed": {
+ "webhook-workflow-job-completed": {
/** @enum {string} */
- readonly action: "completed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow_job: {
- /** Format: uri */
- readonly check_run_url: string;
- readonly completed_at: string | null;
+ action: "completed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out";
+ conclusion: "success" | "failure" | null | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out";
/** @description The time that the job created. */
- readonly created_at: string;
- readonly head_sha: string;
+ created_at: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */
- readonly labels: readonly string[];
- readonly name: string;
- readonly node_id: string;
- readonly run_attempt: number;
- readonly run_id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
/** Format: uri */
- readonly run_url: string;
+ run_url: string;
/** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_group_id: number | null;
+ runner_group_id: number | null;
/** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_group_name: string | null;
+ runner_group_name: string | null;
/** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_id: number | null;
+ runner_id: number | null;
/** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_name: string | null;
- readonly started_at: string;
+ runner_name: string | null;
+ started_at: string;
/**
* @description The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`.
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
+ status: "queued" | "in_progress" | "completed" | "waiting";
/** @description The name of the current branch. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** @description The name of the workflow. */
- readonly workflow_name: string | null;
- readonly steps: readonly {
- readonly completed_at: string | null;
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
/** @enum {string} */
- readonly status: "in_progress" | "completed" | "queued";
+ status: "in_progress" | "completed" | "queued";
}[];
/** Format: uri */
- readonly url: string;
+ url: string;
} & {
- readonly check_run_url?: string;
- readonly completed_at?: string;
+ check_run_url?: string;
+ completed_at?: string;
/** @enum {string} */
- readonly conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out";
+ conclusion: "success" | "failure" | "skipped" | "cancelled" | "action_required" | "neutral" | "timed_out";
/** @description The time that the job created. */
- readonly created_at?: string;
- readonly head_sha?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: readonly (string | null)[];
- readonly name?: string;
- readonly node_id?: string;
- readonly run_attempt?: number;
- readonly run_id?: number;
- readonly run_url?: string;
- readonly runner_group_id?: number | null;
- readonly runner_group_name?: string | null;
- readonly runner_id?: number | null;
- readonly runner_name?: string | null;
- readonly started_at?: string;
- readonly status?: string;
+ created_at?: string;
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ labels?: (string | null)[];
+ name?: string;
+ node_id?: string;
+ run_attempt?: number;
+ run_id?: number;
+ run_url?: string;
+ runner_group_id?: number | null;
+ runner_group_name?: string | null;
+ runner_id?: number | null;
+ runner_name?: string | null;
+ started_at?: string;
+ status?: string;
/** @description The name of the current branch. */
- readonly head_branch?: string | null;
+ head_branch?: string | null;
/** @description The name of the workflow. */
- readonly workflow_name?: string | null;
- readonly steps?: readonly (Record | null)[];
- readonly url?: string;
+ workflow_name?: string | null;
+ steps?: (Record | null)[];
+ url?: string;
};
- readonly deployment?: components["schemas"]["deployment"];
+ deployment?: components["schemas"]["deployment"];
};
/** workflow_job in_progress event */
- readonly "webhook-workflow-job-in-progress": {
+ "webhook-workflow-job-in-progress": {
/** @enum {string} */
- readonly action: "in_progress";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow_job: {
- /** Format: uri */
- readonly check_run_url: string;
- readonly completed_at: string | null;
+ action: "in_progress";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | null | "cancelled" | "neutral";
+ conclusion: "success" | "failure" | null | "cancelled" | "neutral";
/** @description The time that the job created. */
- readonly created_at: string;
- readonly head_sha: string;
+ created_at: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** @description Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. */
- readonly labels: readonly string[];
- readonly name: string;
- readonly node_id: string;
- readonly run_attempt: number;
- readonly run_id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
/** Format: uri */
- readonly run_url: string;
+ run_url: string;
/** @description The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_group_id: number | null;
+ runner_group_id: number | null;
/** @description The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_group_name: string | null;
+ runner_group_name: string | null;
/** @description The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_id: number | null;
+ runner_id: number | null;
/** @description The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. */
- readonly runner_name: string | null;
- readonly started_at: string;
+ runner_name: string | null;
+ started_at: string;
/**
* @description The current status of the job. Can be `queued`, `in_progress`, or `completed`.
* @enum {string}
*/
- readonly status: "queued" | "in_progress" | "completed";
+ status: "queued" | "in_progress" | "completed";
/** @description The name of the current branch. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** @description The name of the workflow. */
- readonly workflow_name: string | null;
- readonly steps: readonly {
- readonly completed_at: string | null;
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "failure" | "skipped" | "success" | null | "cancelled";
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
+ conclusion: "failure" | "skipped" | "success" | null | "cancelled";
+ name: string;
+ number: number;
+ started_at: string | null;
/** @enum {string} */
- readonly status: "in_progress" | "completed" | "queued" | "pending";
+ status: "in_progress" | "completed" | "queued" | "pending";
}[];
/** Format: uri */
- readonly url: string;
+ url: string;
} & {
- readonly check_run_url?: string;
- readonly completed_at?: string | null;
- readonly conclusion?: string | null;
+ check_run_url?: string;
+ completed_at?: string | null;
+ conclusion?: string | null;
/** @description The time that the job created. */
- readonly created_at?: string;
- readonly head_sha?: string;
- readonly html_url?: string;
- readonly id?: number;
- readonly labels?: readonly string[];
- readonly name?: string;
- readonly node_id?: string;
- readonly run_attempt?: number;
- readonly run_id?: number;
- readonly run_url?: string;
- readonly runner_group_id?: number | null;
- readonly runner_group_name?: string | null;
- readonly runner_id?: number | null;
- readonly runner_name?: string | null;
- readonly started_at?: string;
+ created_at?: string;
+ head_sha?: string;
+ html_url?: string;
+ id?: number;
+ labels?: string[];
+ name?: string;
+ node_id?: string;
+ run_attempt?: number;
+ run_id?: number;
+ run_url?: string;
+ runner_group_id?: number | null;
+ runner_group_name?: string | null;
+ runner_id?: number | null;
+ runner_name?: string | null;
+ started_at?: string;
/** @enum {string} */
- readonly status: "in_progress" | "completed" | "queued";
+ status: "in_progress" | "completed" | "queued";
/** @description The name of the current branch. */
- readonly head_branch?: string | null;
+ head_branch?: string | null;
/** @description The name of the workflow. */
- readonly workflow_name?: string | null;
- readonly steps: readonly {
- readonly completed_at: string | null;
- readonly conclusion: string | null;
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
+ workflow_name?: string | null;
+ steps: {
+ completed_at: string | null;
+ conclusion: string | null;
+ name: string;
+ number: number;
+ started_at: string | null;
/** @enum {string} */
- readonly status: "in_progress" | "completed" | "pending" | "queued";
+ status: "in_progress" | "completed" | "pending" | "queued";
}[];
- readonly url?: string;
+ url?: string;
};
- readonly deployment?: components["schemas"]["deployment"];
+ deployment?: components["schemas"]["deployment"];
};
/** workflow_job queued event */
- readonly "webhook-workflow-job-queued": {
+ "webhook-workflow-job-queued": {
/** @enum {string} */
- readonly action: "queued";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow_job: {
- /** Format: uri */
- readonly check_run_url: string;
- readonly completed_at: string | null;
- readonly conclusion: string | null;
+ action: "queued";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ conclusion: string | null;
/** @description The time that the job created. */
- readonly created_at: string;
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly labels: readonly string[];
- readonly name: string;
- readonly node_id: string;
- readonly run_attempt: number;
- readonly run_id: number;
- /** Format: uri */
- readonly run_url: string;
- readonly runner_group_id: number | null;
- readonly runner_group_name: string | null;
- readonly runner_id: number | null;
- readonly runner_name: string | null;
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ runner_group_id: number | null;
+ runner_group_name: string | null;
+ runner_id: number | null;
+ runner_name: string | null;
/** Format: date-time */
- readonly started_at: string;
+ started_at: string;
/** @enum {string} */
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
+ status: "queued" | "in_progress" | "completed" | "waiting";
/** @description The name of the current branch. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** @description The name of the workflow. */
- readonly workflow_name: string | null;
- readonly steps: readonly {
- readonly completed_at: string | null;
+ workflow_name: string | null;
+ steps: {
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
/** @enum {string} */
- readonly status: "completed" | "in_progress" | "queued" | "pending";
+ status: "completed" | "in_progress" | "queued" | "pending";
}[];
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly deployment?: components["schemas"]["deployment"];
+ deployment?: components["schemas"]["deployment"];
};
/** workflow_job waiting event */
- readonly "webhook-workflow-job-waiting": {
+ "webhook-workflow-job-waiting": {
/** @enum {string} */
- readonly action: "waiting";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow_job: {
- /** Format: uri */
- readonly check_run_url: string;
- readonly completed_at: string | null;
- readonly conclusion: string | null;
+ action: "waiting";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow_job: {
+ /** Format: uri */
+ check_run_url: string;
+ completed_at: string | null;
+ conclusion: string | null;
/** @description The time that the job created. */
- readonly created_at: string;
- readonly head_sha: string;
- /** Format: uri */
- readonly html_url: string;
- readonly id: number;
- readonly labels: readonly string[];
- readonly name: string;
- readonly node_id: string;
- readonly run_attempt: number;
- readonly run_id: number;
- /** Format: uri */
- readonly run_url: string;
- readonly runner_group_id: number | null;
- readonly runner_group_name: string | null;
- readonly runner_id: number | null;
- readonly runner_name: string | null;
+ created_at: string;
+ head_sha: string;
+ /** Format: uri */
+ html_url: string;
+ id: number;
+ labels: string[];
+ name: string;
+ node_id: string;
+ run_attempt: number;
+ run_id: number;
+ /** Format: uri */
+ run_url: string;
+ runner_group_id: number | null;
+ runner_group_name: string | null;
+ runner_id: number | null;
+ runner_name: string | null;
/** Format: date-time */
- readonly started_at: string;
+ started_at: string;
/** @description The name of the current branch. */
- readonly head_branch: string | null;
+ head_branch: string | null;
/** @description The name of the workflow. */
- readonly workflow_name: string | null;
+ workflow_name: string | null;
/** @enum {string} */
- readonly status: "queued" | "in_progress" | "completed" | "waiting";
- readonly steps: readonly {
- readonly completed_at: string | null;
+ status: "queued" | "in_progress" | "completed" | "waiting";
+ steps: {
+ completed_at: string | null;
/** @enum {string|null} */
- readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
- readonly name: string;
- readonly number: number;
- readonly started_at: string | null;
+ conclusion: "failure" | "skipped" | "success" | "cancelled" | null;
+ name: string;
+ number: number;
+ started_at: string | null;
/** @enum {string} */
- readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting";
+ status: "completed" | "in_progress" | "queued" | "pending" | "waiting";
}[];
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly deployment?: components["schemas"]["deployment"];
+ deployment?: components["schemas"]["deployment"];
};
/** workflow_run completed event */
- readonly "webhook-workflow-run-completed": {
+ "webhook-workflow-run-completed": {
/** @enum {string} */
- readonly action: "completed";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow: components["schemas"]["webhooks_workflow"];
+ action: "completed";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow: components["schemas"]["webhooks_workflow"];
/** Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: uri */
- readonly artifacts_url: string;
+ artifacts_url: string;
/** Format: uri */
- readonly cancel_url: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
/** Format: uri */
- readonly check_suite_url: string;
+ check_suite_url: string;
/** @enum {string|null} */
- readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null;
+ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "startup_failure" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string | null;
+ created_at: string;
+ event: string;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** Repository Lite */
- readonly head_repository: {
+ head_repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly head_sha: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly jobs_url: string;
+ jobs_url: string;
/** Format: uri */
- readonly logs_url: string;
- readonly name: string | null;
- readonly node_id: string;
- readonly path: string;
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
/** Format: uri */
- readonly previous_attempt_url: string | null;
- readonly pull_requests: readonly ({
- readonly base: {
- readonly ref: string;
+ previous_attempt_url: string | null;
+ pull_requests: ({
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null)[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
/** Repository Lite */
- readonly repository: {
+ repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Format: uri */
- readonly rerun_url: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting";
+ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
+ url: string;
+ workflow_id: number;
/** Format: uri */
- readonly workflow_url: string;
+ workflow_url: string;
/**
* @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.
* @example Simple Workflow
*/
- readonly display_title?: string;
+ display_title?: string;
};
};
/** workflow_run in_progress event */
- readonly "webhook-workflow-run-in-progress": {
+ "webhook-workflow-run-in-progress": {
/** @enum {string} */
- readonly action: "in_progress";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow: components["schemas"]["webhooks_workflow"];
+ action: "in_progress";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow: components["schemas"]["webhooks_workflow"];
/** Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: uri */
- readonly artifacts_url: string;
+ artifacts_url: string;
/** Format: uri */
- readonly cancel_url: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
/** Format: uri */
- readonly check_suite_url: string;
+ check_suite_url: string;
/** @enum {string|null} */
- readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null;
+ conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null;
/** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string | null;
+ created_at: string;
+ event: string;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** Repository Lite */
- readonly head_repository: {
+ head_repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string | null;
- readonly node_id: string;
+ name: string | null;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly head_sha: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly jobs_url: string;
+ jobs_url: string;
/** Format: uri */
- readonly logs_url: string;
- readonly name: string | null;
- readonly node_id: string;
- readonly path: string;
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
/** Format: uri */
- readonly previous_attempt_url: string | null;
- readonly pull_requests: readonly ({
- readonly base: {
- readonly ref: string;
+ previous_attempt_url: string | null;
+ pull_requests: ({
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
} | null)[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
/** Repository Lite */
- readonly repository: {
+ repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Format: uri */
- readonly rerun_url: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending";
+ status: "requested" | "in_progress" | "completed" | "queued" | "pending";
/** User */
- readonly triggering_actor: {
+ triggering_actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
+ url?: string;
} | null;
/** Format: date-time */
- readonly updated_at: string;
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
+ url: string;
+ workflow_id: number;
/** Format: uri */
- readonly workflow_url: string;
+ workflow_url: string;
};
};
/** workflow_run requested event */
- readonly "webhook-workflow-run-requested": {
+ "webhook-workflow-run-requested": {
/** @enum {string} */
- readonly action: "requested";
- readonly enterprise?: components["schemas"]["enterprise-webhooks"];
- readonly installation?: components["schemas"]["simple-installation"];
- readonly organization?: components["schemas"]["organization-simple-webhooks"];
- readonly repository: components["schemas"]["repository-webhooks"];
- readonly sender: components["schemas"]["simple-user"];
- readonly workflow: components["schemas"]["webhooks_workflow"];
+ action: "requested";
+ enterprise?: components["schemas"]["enterprise-webhooks"];
+ installation?: components["schemas"]["simple-installation"];
+ organization?: components["schemas"]["organization-simple-webhooks"];
+ repository: components["schemas"]["repository-webhooks"];
+ sender: components["schemas"]["simple-user"];
+ workflow: components["schemas"]["webhooks_workflow"];
/** Workflow Run */
- readonly workflow_run: {
+ workflow_run: {
/** User */
- readonly actor: {
+ actor: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** Format: uri */
- readonly artifacts_url: string;
+ artifacts_url: string;
/** Format: uri */
- readonly cancel_url: string;
- readonly check_suite_id: number;
- readonly check_suite_node_id: string;
+ cancel_url: string;
+ check_suite_id: number;
+ check_suite_node_id: string;
/** Format: uri */
- readonly check_suite_url: string;
+ check_suite_url: string;
/** @enum {string|null} */
- readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
+ conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure";
/** Format: date-time */
- readonly created_at: string;
- readonly event: string;
- readonly head_branch: string | null;
+ created_at: string;
+ event: string;
+ head_branch: string | null;
/** SimpleCommit */
- readonly head_commit: {
+ head_commit: {
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly author: {
+ author: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
/**
* Committer
* @description Metaproperties for Git author/committer information.
*/
- readonly committer: {
+ committer: {
/** Format: date-time */
- readonly date?: string;
+ date?: string;
/** Format: email */
- readonly email: string | null;
+ email: string | null;
/** @description The git author's name. */
- readonly name: string;
- readonly username?: string;
+ name: string;
+ username?: string;
};
- readonly id: string;
- readonly message: string;
- readonly timestamp: string;
- readonly tree_id: string;
+ id: string;
+ message: string;
+ timestamp: string;
+ tree_id: string;
};
/** Repository Lite */
- readonly head_repository: {
+ head_repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly head_sha: string;
+ head_sha: string;
/** Format: uri */
- readonly html_url: string;
- readonly id: number;
+ html_url: string;
+ id: number;
/** Format: uri */
- readonly jobs_url: string;
+ jobs_url: string;
/** Format: uri */
- readonly logs_url: string;
- readonly name: string | null;
- readonly node_id: string;
- readonly path: string;
+ logs_url: string;
+ name: string | null;
+ node_id: string;
+ path: string;
/** Format: uri */
- readonly previous_attempt_url: string | null;
- readonly pull_requests: readonly {
- readonly base: {
- readonly ref: string;
+ previous_attempt_url: string | null;
+ pull_requests: {
+ base: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly head: {
- readonly ref: string;
+ head: {
+ ref: string;
/** Repo Ref */
- readonly repo: {
- readonly id: number;
- readonly name: string;
+ repo: {
+ id: number;
+ name: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
- readonly sha: string;
+ sha: string;
};
- readonly id: number;
- readonly number: number;
+ id: number;
+ number: number;
/** Format: uri */
- readonly url: string;
+ url: string;
}[];
- readonly referenced_workflows?: readonly {
- readonly path: string;
- readonly ref?: string;
- readonly sha: string;
+ referenced_workflows?: {
+ path: string;
+ ref?: string;
+ sha: string;
}[] | null;
/** Repository Lite */
- readonly repository: {
+ repository: {
/** Format: uri-template */
- readonly archive_url: string;
+ archive_url: string;
/** Format: uri-template */
- readonly assignees_url: string;
+ assignees_url: string;
/** Format: uri-template */
- readonly blobs_url: string;
+ blobs_url: string;
/** Format: uri-template */
- readonly branches_url: string;
+ branches_url: string;
/** Format: uri-template */
- readonly collaborators_url: string;
+ collaborators_url: string;
/** Format: uri-template */
- readonly comments_url: string;
+ comments_url: string;
/** Format: uri-template */
- readonly commits_url: string;
+ commits_url: string;
/** Format: uri-template */
- readonly compare_url: string;
+ compare_url: string;
/** Format: uri-template */
- readonly contents_url: string;
+ contents_url: string;
/** Format: uri */
- readonly contributors_url: string;
+ contributors_url: string;
/** Format: uri */
- readonly deployments_url: string;
- readonly description: string | null;
+ deployments_url: string;
+ description: string | null;
/** Format: uri */
- readonly downloads_url: string;
+ downloads_url: string;
/** Format: uri */
- readonly events_url: string;
- readonly fork: boolean;
+ events_url: string;
+ fork: boolean;
/** Format: uri */
- readonly forks_url: string;
- readonly full_name: string;
+ forks_url: string;
+ full_name: string;
/** Format: uri-template */
- readonly git_commits_url: string;
+ git_commits_url: string;
/** Format: uri-template */
- readonly git_refs_url: string;
+ git_refs_url: string;
/** Format: uri-template */
- readonly git_tags_url: string;
+ git_tags_url: string;
/** Format: uri */
- readonly hooks_url: string;
+ hooks_url: string;
/** Format: uri */
- readonly html_url: string;
+ html_url: string;
/** @description Unique identifier of the repository */
- readonly id: number;
+ id: number;
/** Format: uri-template */
- readonly issue_comment_url: string;
+ issue_comment_url: string;
/** Format: uri-template */
- readonly issue_events_url: string;
+ issue_events_url: string;
/** Format: uri-template */
- readonly issues_url: string;
+ issues_url: string;
/** Format: uri-template */
- readonly keys_url: string;
+ keys_url: string;
/** Format: uri-template */
- readonly labels_url: string;
+ labels_url: string;
/** Format: uri */
- readonly languages_url: string;
+ languages_url: string;
/** Format: uri */
- readonly merges_url: string;
+ merges_url: string;
/** Format: uri-template */
- readonly milestones_url: string;
+ milestones_url: string;
/** @description The name of the repository. */
- readonly name: string;
- readonly node_id: string;
+ name: string;
+ node_id: string;
/** Format: uri-template */
- readonly notifications_url: string;
+ notifications_url: string;
/** User */
- readonly owner: {
+ owner: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ id: number;
+ login: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
/** @description Whether the repository is private or public. */
- readonly private: boolean;
+ private: boolean;
/** Format: uri-template */
- readonly pulls_url: string;
+ pulls_url: string;
/** Format: uri-template */
- readonly releases_url: string;
+ releases_url: string;
/** Format: uri */
- readonly stargazers_url: string;
+ stargazers_url: string;
/** Format: uri-template */
- readonly statuses_url: string;
+ statuses_url: string;
/** Format: uri */
- readonly subscribers_url: string;
+ subscribers_url: string;
/** Format: uri */
- readonly subscription_url: string;
+ subscription_url: string;
/** Format: uri */
- readonly tags_url: string;
+ tags_url: string;
/** Format: uri */
- readonly teams_url: string;
+ teams_url: string;
/** Format: uri-template */
- readonly trees_url: string;
+ trees_url: string;
/** Format: uri */
- readonly url: string;
+ url: string;
};
/** Format: uri */
- readonly rerun_url: string;
- readonly run_attempt: number;
- readonly run_number: number;
+ rerun_url: string;
+ run_attempt: number;
+ run_number: number;
/** Format: date-time */
- readonly run_started_at: string;
+ run_started_at: string;
/** @enum {string} */
- readonly status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting";
+ status: "requested" | "in_progress" | "completed" | "queued" | "pending" | "waiting";
+ /** User */
+ triggering_actor: {
+ /** 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;
+ user_view_type?: string;
+ } | null;
+ /** Format: date-time */
+ updated_at: string;
+ /** Format: uri */
+ url: string;
+ workflow_id: number;
+ /** Format: uri */
+ workflow_url: string;
+ display_title: string;
+ };
+ };
+ /** CreateEvent */
+ "create-event": {
+ ref: string;
+ ref_type: string;
+ full_ref: string;
+ master_branch: string;
+ description?: string | null;
+ pusher_type: string;
+ };
+ /** DeleteEvent */
+ "delete-event": {
+ ref: string;
+ ref_type: string;
+ full_ref: string;
+ pusher_type: string;
+ };
+ /** DiscussionEvent */
+ "discussion-event": {
+ action: string;
+ discussion: components["schemas"]["discussion"];
+ };
+ /** IssuesEvent */
+ "issues-event": {
+ action: string;
+ issue: components["schemas"]["issue"];
+ assignee?: components["schemas"]["simple-user"];
+ assignees?: components["schemas"]["simple-user"][];
+ label?: components["schemas"]["label"];
+ labels?: components["schemas"]["label"][];
+ };
+ /** IssueCommentEvent */
+ "issue-comment-event": {
+ action: string;
+ issue: components["schemas"]["issue"];
+ comment: components["schemas"]["issue-comment"];
+ };
+ /** ForkEvent */
+ "fork-event": {
+ action: string;
+ forkee: {
+ id?: number;
+ node_id?: string;
+ name?: string;
+ full_name?: string;
+ private?: boolean;
+ owner?: components["schemas"]["simple-user"];
+ html_url?: string;
+ description?: string | null;
+ fork?: boolean;
+ url?: string;
+ forks_url?: string;
+ keys_url?: string;
+ collaborators_url?: string;
+ teams_url?: string;
+ hooks_url?: string;
+ issue_events_url?: string;
+ events_url?: string;
+ assignees_url?: string;
+ branches_url?: string;
+ tags_url?: string;
+ blobs_url?: string;
+ git_tags_url?: string;
+ git_refs_url?: string;
+ trees_url?: string;
+ statuses_url?: string;
+ languages_url?: string;
+ stargazers_url?: string;
+ contributors_url?: string;
+ subscribers_url?: string;
+ subscription_url?: string;
+ commits_url?: string;
+ git_commits_url?: string;
+ comments_url?: string;
+ issue_comment_url?: string;
+ contents_url?: string;
+ compare_url?: string;
+ merges_url?: string;
+ archive_url?: string;
+ downloads_url?: string;
+ issues_url?: string;
+ pulls_url?: string;
+ milestones_url?: string;
+ notifications_url?: string;
+ labels_url?: string;
+ releases_url?: string;
+ deployments_url?: string;
+ /** Format: date-time */
+ created_at?: string | null;
+ /** Format: date-time */
+ updated_at?: string | null;
+ /** Format: date-time */
+ pushed_at?: string | null;
+ git_url?: string;
+ ssh_url?: string;
+ clone_url?: string;
+ svn_url?: string;
+ homepage?: string | null;
+ size?: number;
+ stargazers_count?: number;
+ watchers_count?: number;
+ language?: string | null;
+ has_issues?: boolean;
+ has_projects?: boolean;
+ has_downloads?: boolean;
+ has_wiki?: boolean;
+ has_pages?: boolean;
+ has_discussions?: boolean;
+ has_pull_requests?: boolean;
+ /**
+ * @description The policy controlling who can create pull requests: all or collaborators_only.
+ * @enum {string}
+ */
+ pull_request_creation_policy?: "all" | "collaborators_only";
+ forks_count?: number;
+ mirror_url?: string | null;
+ archived?: boolean;
+ disabled?: boolean;
+ open_issues_count?: number;
+ license?: components["schemas"]["nullable-license-simple"];
+ allow_forking?: boolean;
+ is_template?: boolean;
+ web_commit_signoff_required?: boolean;
+ topics?: string[];
+ visibility?: string;
+ forks?: number;
+ open_issues?: number;
+ watchers?: number;
+ default_branch?: string;
+ public?: boolean;
+ };
+ };
+ /** GollumEvent */
+ "gollum-event": {
+ pages: {
+ page_name?: string | null;
+ title?: string | null;
+ summary?: string | null;
+ action?: string;
+ sha?: string;
+ html_url?: string;
+ }[];
+ };
+ /** MemberEvent */
+ "member-event": {
+ action: string;
+ member: components["schemas"]["simple-user"];
+ };
+ /** PublicEvent */
+ "public-event": Record;
+ /** PushEvent */
+ "push-event": {
+ repository_id: number;
+ push_id: number;
+ ref: string;
+ head: string;
+ before: string;
+ };
+ /** PullRequestEvent */
+ "pull-request-event": {
+ action: string;
+ number: number;
+ pull_request: components["schemas"]["pull-request-minimal"];
+ assignee?: components["schemas"]["simple-user"];
+ assignees?: components["schemas"]["simple-user"][];
+ label?: components["schemas"]["label"];
+ labels?: components["schemas"]["label"][];
+ };
+ /** PullRequestReviewCommentEvent */
+ "pull-request-review-comment-event": {
+ action: string;
+ pull_request: components["schemas"]["pull-request-minimal"];
+ comment: {
+ id: number;
+ node_id: string;
+ /** Format: uri */
+ url: string;
+ pull_request_review_id: number | null;
+ diff_hunk: string;
+ path: string;
+ position: number | null;
+ original_position: number;
+ subject_type?: string | null;
+ commit_id: string;
/** User */
- readonly triggering_actor: {
+ user: {
/** Format: uri */
- readonly avatar_url?: string;
- readonly deleted?: boolean;
- readonly email?: string | null;
+ avatar_url?: string;
+ deleted?: boolean;
+ email?: string | null;
/** Format: uri-template */
- readonly events_url?: string;
+ events_url?: string;
/** Format: uri */
- readonly followers_url?: string;
+ followers_url?: string;
/** Format: uri-template */
- readonly following_url?: string;
+ following_url?: string;
/** Format: uri-template */
- readonly gists_url?: string;
- readonly gravatar_id?: string;
+ gists_url?: string;
+ gravatar_id?: string;
/** Format: uri */
- readonly html_url?: string;
- readonly id: number;
- readonly login: string;
- readonly name?: string;
- readonly node_id?: string;
+ html_url?: string;
+ /** Format: int64 */
+ id?: number;
+ login?: string;
+ name?: string;
+ node_id?: string;
/** Format: uri */
- readonly organizations_url?: string;
+ organizations_url?: string;
/** Format: uri */
- readonly received_events_url?: string;
+ received_events_url?: string;
/** Format: uri */
- readonly repos_url?: string;
- readonly site_admin?: boolean;
+ repos_url?: string;
+ site_admin?: boolean;
/** Format: uri-template */
- readonly starred_url?: string;
+ starred_url?: string;
/** Format: uri */
- readonly subscriptions_url?: string;
+ subscriptions_url?: string;
/** @enum {string} */
- readonly type?: "Bot" | "User" | "Organization";
+ type?: "Bot" | "User" | "Organization";
/** Format: uri */
- readonly url?: string;
- readonly user_view_type?: string;
+ url?: string;
+ user_view_type?: string;
} | null;
+ body: string;
/** Format: date-time */
- readonly updated_at: string;
+ created_at: string;
+ /** Format: date-time */
+ updated_at: string;
/** Format: uri */
- readonly url: string;
- readonly workflow_id: number;
+ html_url: string;
+ /** Format: uri */
+ pull_request_url: string;
+ _links: {
+ /** Link */
+ html: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ pull_request: {
+ /** Format: uri-template */
+ href: string;
+ };
+ /** Link */
+ self: {
+ /** Format: uri-template */
+ href: string;
+ };
+ };
+ original_commit_id: string;
+ /** 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;
+ };
+ in_reply_to_id?: number;
+ };
+ };
+ /** PullRequestReviewEvent */
+ "pull-request-review-event": {
+ action: string;
+ review: {
+ id?: number;
+ node_id?: string;
+ user?: components["schemas"]["nullable-simple-user"];
+ body?: string;
+ commit_id?: string;
+ submitted_at?: string | null;
+ state?: string;
+ /** Format: uri */
+ html_url?: string;
+ /** Format: uri */
+ pull_request_url?: string;
+ _links?: {
+ html: {
+ href: string;
+ };
+ pull_request: {
+ href: string;
+ };
+ };
+ updated_at?: string;
+ };
+ pull_request: components["schemas"]["pull-request-minimal"];
+ };
+ /** CommitCommentEvent */
+ "commit-comment-event": {
+ action: string;
+ comment: {
/** Format: uri */
- readonly workflow_url: string;
- readonly display_title: string;
+ html_url?: string;
+ /** Format: uri */
+ url?: string;
+ id?: number;
+ node_id?: string;
+ body?: string;
+ path?: string | null;
+ position?: number | null;
+ line?: number | null;
+ commit_id?: string;
+ user?: components["schemas"]["nullable-simple-user"];
+ /** Format: date-time */
+ created_at?: string;
+ /** Format: date-time */
+ updated_at?: string;
+ reactions?: components["schemas"]["reaction-rollup"];
+ };
+ };
+ /** ReleaseEvent */
+ "release-event": {
+ action: string;
+ release: components["schemas"]["release"] & {
+ is_short_description_html_truncated?: boolean;
+ short_description_html?: string;
};
};
+ /** WatchEvent */
+ "watch-event": {
+ action: string;
+ };
};
responses: {
/** @description Validation failed, or the endpoint has been spammed. */
- readonly validation_failed_simple: {
+ validation_failed_simple: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["validation-error-simple"];
+ "application/json": components["schemas"]["validation-error-simple"];
};
};
/** @description Resource not found */
- readonly not_found: {
+ not_found: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Bad Request */
- readonly bad_request: {
+ bad_request: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
- readonly "application/scim+json": components["schemas"]["scim-error"];
+ "application/json": components["schemas"]["basic-error"];
+ "application/scim+json": components["schemas"]["scim-error"];
};
};
/** @description Validation failed, or the endpoint has been spammed. */
- readonly validation_failed: {
+ validation_failed: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["validation-error"];
+ "application/json": components["schemas"]["validation-error"];
};
};
/** @description Accepted */
- readonly accepted: {
+ accepted: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": Record;
+ "application/json": Record;
};
};
/** @description Not modified */
- readonly not_modified: {
+ not_modified: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Requires authentication */
- readonly requires_authentication: {
+ requires_authentication: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Forbidden */
- readonly forbidden: {
+ forbidden: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Internal Error */
+ internal_error: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Conflict */
- readonly conflict: {
+ conflict: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description A header with no content is returned. */
- readonly no_content: {
+ no_content: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Service unavailable */
- readonly service_unavailable: {
+ service_unavailable: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly code?: string;
- readonly message?: string;
- readonly documentation_url?: string;
+ "application/json": {
+ code?: string;
+ message?: string;
+ documentation_url?: string;
};
};
};
/** @description Forbidden Gist */
- readonly forbidden_gist: {
+ forbidden_gist: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly block?: {
- readonly reason?: string;
- readonly created_at?: string;
- readonly html_url?: string | null;
+ "application/json": {
+ block?: {
+ reason?: string;
+ created_at?: string;
+ html_url?: string | null;
};
- readonly message?: string;
- readonly documentation_url?: string;
+ message?: string;
+ documentation_url?: string;
};
};
};
/** @description Moved permanently */
- readonly moved_permanently: {
+ moved_permanently: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response when getting all budgets */
+ get_all_budgets: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["get_all_budgets"];
+ };
+ };
+ /** @description Response when updating a budget */
+ budget: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["get-budget"];
+ };
+ };
+ /** @description Response when deleting a budget */
+ "delete-budget": {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["delete-budget"];
+ };
+ };
+ /** @description Response when getting a billing premium request usage report */
+ billing_premium_request_usage_report_org: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["billing-premium-request-usage-report-org"];
};
};
/** @description Billing usage report response for an organization */
- readonly billing_usage_report_org: {
+ billing_usage_report_org: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["billing-usage-report"];
+ "application/json": components["schemas"]["billing-usage-report"];
};
};
- /** @description Internal Error */
- readonly internal_error: {
+ /** @description Response when getting a billing usage summary */
+ billing_usage_summary_report_org: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["billing-usage-summary-report-org"];
};
};
/** @description Response */
- readonly actions_runner_jitconfig: {
+ actions_runner_jitconfig: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly runner: components["schemas"]["runner"];
+ "application/json": {
+ runner: components["schemas"]["runner"];
/** @description The base64 encoded runner configuration. */
- readonly encoded_jit_config: string;
+ encoded_jit_config: string;
};
};
};
/** @description Response */
- readonly actions_runner_labels: {
+ actions_runner_labels: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly labels: readonly components["schemas"]["runner-label"][];
+ "application/json": {
+ total_count: number;
+ labels: components["schemas"]["runner-label"][];
};
};
};
/** @description Response */
- readonly actions_runner_labels_readonly: {
+ actions_runner_labels_readonly: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly labels: readonly components["schemas"]["runner-label"][];
+ "application/json": {
+ total_count: number;
+ labels: components["schemas"]["runner-label"][];
};
};
};
+ /** @description Payload Too Large */
+ too_large: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
/** @description Copilot Usage Merics API setting is disabled at the organization or enterprise level. */
- readonly usage_metrics_api_disabled: {
+ usage_metrics_api_disabled: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description The value of `per_page` multiplied by `page` cannot be greater than 10000. */
- readonly package_es_list_error: {
+ package_es_list_error: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- /** @description Gone */
- readonly gone: {
+ /** @description Unprocessable entity if you attempt to modify an enterprise team at the organization level. */
+ enterprise_team_unsupported: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ /** @description Temporary Redirect */
+ temporary_redirect: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
- /** @description Temporary Redirect */
- readonly temporary_redirect: {
+ /** @description Gone */
+ gone: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Response if GitHub Advanced Security is not enabled for this repository */
- readonly code_scanning_forbidden_read: {
+ code_scanning_forbidden_read: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository */
- readonly code_scanning_forbidden_write: {
+ code_scanning_forbidden_write: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Bad Request */
- readonly code_scanning_bad_request: {
+ code_scanning_bad_request: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Response if the repository is archived, if GitHub Advanced Security is not enabled for this repository or if rate limit is exceeded */
- readonly code_scanning_autofix_create_forbidden: {
+ code_scanning_autofix_create_forbidden: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response if analysis could not be processed */
+ unprocessable_analysis: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Found */
- readonly found: {
+ found: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if there is already a validation run in progress with a different default setup configuration */
- readonly code_scanning_conflict: {
+ code_scanning_conflict: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
- /** @description Response if GitHub Advanced Security is not enabled for this repository */
- readonly dependency_review_forbidden: {
+ /** @description Response if the configuration change cannot be made because the repository is not in the required state */
+ code_scanning_invalid_state: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response for a private repository when GitHub Advanced Security is not enabled, or if used against a fork */
+ dependency_review_forbidden: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Unavailable due to service under maintenance. */
- readonly porter_maintenance: {
+ porter_maintenance: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
/** @description Unacceptable */
- readonly unacceptable: {
+ unacceptable: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Response when getting a billing premium request usage report */
+ billing_premium_request_usage_report_user: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["billing-premium-request-usage-report-user"];
+ };
+ };
+ /** @description Response when getting a billing usage report */
+ billing_usage_report_user: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["billing-usage-report-user"];
+ };
+ };
+ /** @description Response when getting a billing usage summary */
+ billing_usage_summary_report_user: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["billing-usage-summary-report-user"];
};
};
};
parameters: {
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly "pagination-before": string;
+ "pagination-before": string;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly "pagination-after": string;
+ "pagination-after": string;
/** @description The direction to sort the results by. */
- readonly direction: "asc" | "desc";
+ direction: "asc" | "desc";
/** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */
- readonly ghsa_id: string;
+ ghsa_id: string;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly "per-page": number;
+ "per-page": number;
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- readonly cursor: string;
- readonly "delivery-id": number;
+ cursor: string;
+ "delivery-id": number;
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page: number;
+ page: number;
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since: string;
+ since: string;
/** @description The unique identifier of the installation. */
- readonly "installation-id": number;
+ "installation-id": number;
/** @description The client ID of the GitHub app. */
- readonly "client-id": string;
- readonly "app-slug": string;
+ "client-id": string;
+ "app-slug": string;
/** @description The unique identifier of the classroom assignment. */
- readonly "assignment-id": number;
+ "assignment-id": number;
/** @description The unique identifier of the classroom. */
- readonly "classroom-id": number;
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: string;
+ "classroom-id": number;
+ /** @description The slug version of the enterprise name. */
+ enterprise: string;
/** @description The unique identifier of the code security configuration. */
- readonly "configuration-id": number;
+ "configuration-id": number;
/**
* @description A comma-separated list of states. If specified, only alerts with these states will be returned.
*
* Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
*/
- readonly "dependabot-alert-comma-separated-states": string;
+ "dependabot-alert-comma-separated-states": string;
/**
* @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
*
* Can be: `low`, `medium`, `high`, `critical`
*/
- readonly "dependabot-alert-comma-separated-severities": string;
+ "dependabot-alert-comma-separated-severities": string;
/**
* @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
*
* Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
*/
- readonly "dependabot-alert-comma-separated-ecosystems": string;
+ "dependabot-alert-comma-separated-ecosystems": string;
/** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- readonly "dependabot-alert-comma-separated-packages": string;
+ "dependabot-alert-comma-separated-packages": string;
/**
* @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
* - An exact number (`n`)
@@ -87694,1748 +92780,2002 @@ export type components = {
*
* Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
*/
- readonly "dependabot-alert-comma-separated-epss": string;
+ "dependabot-alert-comma-separated-epss": string;
+ /**
+ * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
+ * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
+ */
+ "dependabot-alert-comma-separated-has": string | "patch"[];
+ /**
+ * @description Filter alerts by assignees.
+ * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ "dependabot-alert-comma-separated-assignees": string;
/** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */
- readonly "dependabot-alert-scope": "development" | "runtime";
+ "dependabot-alert-scope": "development" | "runtime";
/**
* @description The property by which to sort the results.
* `created` means when the alert was created.
* `updated` means when the alert's state last changed.
* `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.
*/
- readonly "dependabot-alert-sort": "created" | "updated" | "epss_percentage";
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
- * This parameter must not be used in combination with `last`.
- * Instead, use `per_page` in combination with `after` to fetch the first page of results.
- */
- readonly "pagination-first": number;
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result.
- * This parameter must not be used in combination with `first`.
- * Instead, use `per_page` in combination with `before` to fetch the last page of results.
- */
- readonly "pagination-last": number;
- /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- readonly "secret-scanning-alert-state": "open" | "resolved";
- /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */
- readonly "secret-scanning-alert-secret-type": string;
- /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- readonly "secret-scanning-alert-resolution": string;
- /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- readonly "secret-scanning-alert-sort": "created" | "updated";
- /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
- readonly "secret-scanning-alert-validity": string;
- /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */
- readonly "secret-scanning-alert-publicly-leaked": boolean;
- /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */
- readonly "secret-scanning-alert-multi-repo": boolean;
+ "dependabot-alert-sort": "created" | "updated" | "epss_percentage";
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": string;
+ /** @description The handle for the GitHub user account. */
+ username: string;
+ /** @description The organization name. The name is not case sensitive. */
+ org: string;
+ /** @description The slug of the team name. */
+ "team-slug": string;
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ "public-events-per-page": number;
/** @description The unique identifier of the gist. */
- readonly "gist-id": string;
+ "gist-id": string;
/** @description The unique identifier of the comment. */
- readonly "comment-id": number;
+ "comment-id": number;
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
- readonly labels: string;
+ labels: string;
/** @description account_id parameter */
- readonly "account-id": number;
+ "account-id": number;
/** @description The unique identifier of the plan. */
- readonly "plan-id": number;
+ "plan-id": number;
/** @description The property to sort the results by. */
- readonly sort: "created" | "updated";
+ sort: "created" | "updated";
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: string;
+ owner: string;
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: string;
+ repo: string;
/** @description If `true`, show notifications marked as read. */
- readonly all: boolean;
+ all: boolean;
/** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */
- readonly participating: boolean;
+ participating: boolean;
/** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly before: string;
+ before: string;
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly "thread-id": number;
+ "thread-id": number;
/** @description An organization ID. Only return organizations with an ID greater than this ID. */
- readonly "since-org": number;
- /** @description The organization name. The name is not case sensitive. */
- readonly org: string;
- /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */
- readonly "billing-usage-report-year": number;
- /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */
- readonly "billing-usage-report-month": number;
- /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */
- readonly "billing-usage-report-day": number;
- /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */
- readonly "billing-usage-report-hour": number;
+ "since-org": number;
+ /** @description The ID corresponding to the budget. */
+ budget: string;
+ /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */
+ "billing-usage-report-year": number;
+ /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */
+ "billing-usage-report-month-default": number;
+ /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */
+ "billing-usage-report-day": number;
+ /** @description The user name to query usage for. The name is not case sensitive. */
+ "billing-usage-report-user": string;
+ /** @description The model name to query usage for. The name is not case sensitive. */
+ "billing-usage-report-model": string;
+ /** @description The product name to query usage for. The name is not case sensitive. */
+ "billing-usage-report-product": string;
+ /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */
+ "billing-usage-report-month": number;
+ /** @description The repository name to query for usage in the format owner/repository. */
+ "billing-usage-report-repository": string;
+ /** @description The SKU to query for usage. */
+ "billing-usage-report-sku": string;
+ /** @description Image definition ID of custom image */
+ "actions-custom-image-definition-id": number;
+ /** @description Version of a custom image */
+ "actions-custom-image-version": string;
/** @description Unique identifier of the GitHub-hosted runner. */
- readonly "hosted-runner-id": number;
+ "hosted-runner-id": number;
/** @description The unique identifier of the repository. */
- readonly "repository-id": number;
+ "repository-id": number;
/** @description Only return runner groups that are allowed to be used by this repository. */
- readonly "visible-to-repository": string;
+ "visible-to-repository": string;
/** @description Unique identifier of the self-hosted runner group. */
- readonly "runner-group-id": number;
+ "runner-group-id": number;
/** @description Unique identifier of the self-hosted runner. */
- readonly "runner-id": number;
+ "runner-id": number;
/** @description The name of a self-hosted runner's custom label. */
- readonly "runner-label-name": string;
+ "runner-label-name": string;
/** @description The name of the secret. */
- readonly "secret-name": string;
+ "secret-name": string;
/** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly "variables-per-page": number;
+ "variables-per-page": number;
/** @description The name of the variable. */
- readonly "variable-name": string;
- /** @description The handle for the GitHub user account. */
- readonly username: string;
+ "variable-name": string;
+ /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */
+ "subject-digest": string;
/** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- readonly "tool-name": components["schemas"]["code-scanning-analysis-tool-name"];
+ "tool-name": components["schemas"]["code-scanning-analysis-tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- readonly "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"];
+ "tool-guid": components["schemas"]["code-scanning-analysis-tool-guid"];
+ /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */
+ "dependabot-alert-comma-separated-artifact-registry-urls": string;
+ /**
+ * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.
+ *
+ * Can be: `jfrog-artifactory`
+ */
+ "dependabot-alert-comma-separated-artifact-registry": string;
+ /**
+ * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
+ * Multiple `has` filters can be passed to filter for alerts that have all of the values.
+ */
+ "dependabot-alert-org-scope-comma-separated-has": string | ("patch" | "deployment")[];
+ /**
+ * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.
+ *
+ * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`
+ */
+ "dependabot-alert-comma-separated-runtime-risk": string;
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly "hook-id": number;
+ "hook-id": number;
/** @description The type of the actor */
- readonly "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server";
+ "api-insights-actor-type": "installation" | "classic_pat" | "fine_grained_pat" | "oauth_app" | "github_app_user_to_server";
/** @description The ID of the actor */
- readonly "api-insights-actor-id": number;
+ "api-insights-actor-id": number;
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "api-insights-min-timestamp": string;
+ "api-insights-min-timestamp": string;
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "api-insights-max-timestamp": string;
+ "api-insights-max-timestamp": string;
/** @description The property to sort the results by. */
- readonly "api-insights-route-stats-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[];
+ "api-insights-route-stats-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "http_method" | "api_route" | "total_request_count")[];
/** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */
- readonly "api-insights-api-route-substring": string;
+ "api-insights-api-route-substring": string;
/** @description The property to sort the results by. */
- readonly "api-insights-sort": readonly ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[];
+ "api-insights-sort": ("last_rate_limited_timestamp" | "last_request_timestamp" | "rate_limited_request_count" | "subject_name" | "total_request_count")[];
/** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */
- readonly "api-insights-subject-name-substring": string;
+ "api-insights-subject-name-substring": string;
/** @description The ID of the user to query for stats */
- readonly "api-insights-user-id": string;
+ "api-insights-user-id": string;
/** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */
- readonly "api-insights-timestamp-increment": string;
+ "api-insights-timestamp-increment": string;
/** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */
- readonly "api-insights-actor-name-substring": string;
+ "api-insights-actor-name-substring": string;
/** @description The unique identifier of the invitation. */
- readonly "invitation-id": number;
+ "invitation-id": number;
+ /** @description The unique identifier of the issue type. */
+ "issue-type-id": number;
/** @description The name of the codespace. */
- readonly "codespace-name": string;
+ "codespace-name": string;
/** @description The unique identifier of the migration. */
- readonly "migration-id": number;
+ "migration-id": number;
/** @description repo_name parameter */
- readonly "repo-name": string;
- /** @description The slug of the team name. */
- readonly "team-slug": string;
+ "repo-name": string;
/** @description The unique identifier of the role. */
- readonly "role-id": number;
+ "role-id": number;
/**
* @description The selected visibility of the packages. This parameter is optional and only filters an existing result set.
*
* The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
* For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*/
- readonly "package-visibility": "public" | "private" | "internal";
+ "package-visibility": "public" | "private" | "internal";
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container";
+ "package-type": "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container";
/** @description The name of the package. */
- readonly "package-name": string;
+ "package-name": string;
/** @description Unique identifier of the package version. */
- readonly "package-version-id": number;
+ "package-version-id": number;
/** @description The property by which to sort the results. */
- readonly "personal-access-token-sort": "created_at";
+ "personal-access-token-sort": "created_at";
/** @description A list of owner usernames to use to filter the results. */
- readonly "personal-access-token-owner": readonly string[];
+ "personal-access-token-owner": string[];
/** @description The name of the repository to use to filter the results. */
- readonly "personal-access-token-repository": string;
+ "personal-access-token-repository": string;
/** @description The permission to use to filter the results. */
- readonly "personal-access-token-permission": string;
+ "personal-access-token-permission": string;
/** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "personal-access-token-before": string;
+ "personal-access-token-before": string;
/** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "personal-access-token-after": string;
+ "personal-access-token-after": string;
+ /** @description The ID of the token */
+ "personal-access-token-token-id": string[];
/** @description The unique identifier of the fine-grained personal access token. */
- readonly "fine-grained-personal-access-token-id": number;
+ "fine-grained-personal-access-token-id": number;
+ /** @description The project's number. */
+ "project-number": number;
+ /** @description The unique identifier of the field. */
+ "field-id": number;
+ /** @description The unique identifier of the project item. */
+ "item-id": number;
+ /** @description The number that identifies the project view. */
+ "view-number": number;
/** @description The custom property name */
- readonly "custom-property-name": string;
+ "custom-property-name": string;
/**
* @description A comma-separated list of rule targets to filter by.
* If provided, only rulesets that apply to the specified targets will be returned.
* For example, `branch,tag,push`.
*/
- readonly "ruleset-targets": string;
+ "ruleset-targets": string;
/** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */
- readonly "ref-in-query": string;
+ "ref-in-query": string;
/** @description The name of the repository to filter on. */
- readonly "repository-name-in-query": string;
+ "repository-name-in-query": string;
/**
* @description The time period to filter by.
*
- * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).
+ * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).
*/
- readonly "time-period": "hour" | "day" | "week" | "month";
+ "time-period": "hour" | "day" | "week" | "month";
/** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */
- readonly "actor-name-in-query": string;
- /** @description The rule results to filter on. When specified, only suites with this result will be returned. */
- readonly "rule-suite-result": "pass" | "fail" | "bypass" | "all";
+ "actor-name-in-query": string;
+ /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */
+ "rule-suite-result": "pass" | "fail" | "bypass" | "all";
/**
* @description The unique identifier of the rule suite result.
* To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)
* for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)
* for organizations.
*/
- readonly "rule-suite-id": number;
+ "rule-suite-id": number;
+ /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
+ "secret-scanning-alert-state": "open" | "resolved";
+ /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */
+ "secret-scanning-alert-secret-type": string;
+ /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
+ "secret-scanning-alert-resolution": string;
+ /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */
+ "secret-scanning-alert-assignee": string;
+ /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
+ "secret-scanning-alert-sort": "created" | "updated";
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
- readonly "secret-scanning-pagination-before-org-repo": string;
+ "secret-scanning-pagination-before-org-repo": string;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
- readonly "secret-scanning-pagination-after-org-repo": string;
+ "secret-scanning-pagination-after-org-repo": string;
+ /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
+ "secret-scanning-alert-validity": string;
+ /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */
+ "secret-scanning-alert-publicly-leaked": boolean;
+ /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */
+ "secret-scanning-alert-multi-repo": boolean;
+ /** @description A boolean value representing whether or not to hide literal secrets in the results. */
+ "secret-scanning-alert-hide-secret": boolean;
/** @description Unique identifier of the hosted compute network configuration. */
- readonly "network-configuration-id": string;
+ "network-configuration-id": string;
/** @description Unique identifier of the hosted compute network settings. */
- readonly "network-settings-id": string;
- /** @description The number that identifies the discussion. */
- readonly "discussion-number": number;
- /** @description The number that identifies the comment. */
- readonly "comment-number": number;
- /** @description The unique identifier of the reaction. */
- readonly "reaction-id": number;
- /** @description The unique identifier of the project. */
- readonly "project-id": number;
+ "network-settings-id": string;
/** @description The security feature to enable or disable. */
- readonly "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection";
+ "security-product": "dependency_graph" | "dependabot_alerts" | "dependabot_security_updates" | "advanced_security" | "code_scanning_default_setup" | "secret_scanning" | "secret_scanning_push_protection";
/**
* @description The action to take.
*
* `enable_all` means to enable the specified security feature for all repositories in the organization.
* `disable_all` means to disable the specified security feature for all repositories in the organization.
*/
- readonly "org-security-product-enablement": "enable_all" | "disable_all";
- /** @description The unique identifier of the card. */
- readonly "card-id": number;
- /** @description The unique identifier of the column. */
- readonly "column-id": number;
+ "org-security-product-enablement": "enable_all" | "disable_all";
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
- readonly "artifact-name": string;
+ "artifact-name": string;
/** @description The unique identifier of the artifact. */
- readonly "artifact-id": number;
+ "artifact-id": number;
/** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */
- readonly "actions-cache-git-ref-full": string;
+ "actions-cache-git-ref-full": string;
/** @description An explicit key or prefix for identifying the cache */
- readonly "actions-cache-key": string;
+ "actions-cache-key": string;
/** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */
- readonly "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes";
+ "actions-cache-list-sort": "created_at" | "last_accessed_at" | "size_in_bytes";
/** @description A key for identifying the cache. */
- readonly "actions-cache-key-required": string;
+ "actions-cache-key-required": string;
/** @description The unique identifier of the GitHub Actions cache. */
- readonly "cache-id": number;
+ "cache-id": number;
/** @description The unique identifier of the job. */
- readonly "job-id": number;
+ "job-id": number;
/** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- readonly actor: string;
+ actor: string;
/** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- readonly "workflow-run-branch": string;
+ "workflow-run-branch": string;
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- readonly event: string;
+ event: string;
/** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
- readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending";
+ "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending";
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- readonly created: string;
+ created: string;
/** @description If `true` pull requests are omitted from the response (empty array). */
- readonly "exclude-pull-requests": boolean;
+ "exclude-pull-requests": boolean;
/** @description Returns workflow runs with the `check_suite_id` that you specify. */
- readonly "workflow-run-check-suite-id": number;
+ "workflow-run-check-suite-id": number;
/** @description Only returns workflow runs that are associated with the specified `head_sha`. */
- readonly "workflow-run-head-sha": string;
+ "workflow-run-head-sha": string;
/** @description The unique identifier of the workflow run. */
- readonly "run-id": number;
+ "run-id": number;
/** @description The attempt number of the workflow run. */
- readonly "attempt-number": number;
+ "attempt-number": number;
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly "workflow-id": number | string;
+ "workflow-id": number | string;
/** @description The unique identifier of the autolink. */
- readonly "autolink-id": number;
+ "autolink-id": number;
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: string;
+ branch: string;
/** @description The unique identifier of the check run. */
- readonly "check-run-id": number;
+ "check-run-id": number;
/** @description The unique identifier of the check suite. */
- readonly "check-suite-id": number;
+ "check-suite-id": number;
/** @description Returns check runs with the specified `name`. */
- readonly "check-name": string;
+ "check-name": string;
/** @description Returns check runs with the specified `status`. */
- readonly status: "queued" | "in_progress" | "completed";
+ status: "queued" | "in_progress" | "completed";
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- readonly "git-ref": components["schemas"]["code-scanning-ref"];
+ "git-ref": components["schemas"]["code-scanning-ref"];
/** @description The number of the pull request for the results you want to list. */
- readonly "pr-alias": number;
+ "pr-alias": number;
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly "alert-number": components["schemas"]["alert-number"];
+ "alert-number": components["schemas"]["alert-number"];
+ /** @description The unique identifier of the reaction. */
+ "reaction-id": number;
/** @description The SHA of the commit. */
- readonly "commit-sha": string;
+ "commit-sha": string;
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly "commit-ref": string;
+ "commit-ref": string;
/** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */
- readonly "dependabot-alert-comma-separated-manifests": string;
+ "dependabot-alert-comma-separated-manifests": string;
/**
* @description The number that identifies a Dependabot alert in its repository.
* You can find this at the end of the URL for a Dependabot alert within GitHub,
* or in `number` fields in the response from the
* `GET /repos/{owner}/{repo}/dependabot/alerts` operation.
*/
- readonly "dependabot-alert-number": components["schemas"]["alert-number"];
+ "dependabot-alert-number": components["schemas"]["alert-number"];
/** @description The full path, relative to the repository root, of the dependency manifest file. */
- readonly "manifest-path": string;
+ "manifest-path": string;
/** @description deployment_id parameter */
- readonly "deployment-id": number;
+ "deployment-id": number;
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly "environment-name": string;
+ "environment-name": string;
/** @description The unique identifier of the branch policy. */
- readonly "branch-policy-id": number;
+ "branch-policy-id": number;
/** @description The unique identifier of the protection rule. */
- readonly "protection-rule-id": number;
+ "protection-rule-id": number;
/**
* @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
* @example heads/feature-a
*/
- readonly "git-ref-only": string;
+ "git-ref-only": string;
/** @description A user ID. Only return users with an ID greater than this ID. */
- readonly "since-user": number;
+ "since-user": number;
/** @description The number that identifies the issue. */
- readonly "issue-number": number;
+ "issue-number": number;
/** @description The unique identifier of the key. */
- readonly "key-id": number;
+ "key-id": number;
/** @description The number that identifies the milestone. */
- readonly "milestone-number": number;
+ "milestone-number": number;
/** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */
- readonly "pages-deployment-id": number | string;
+ "pages-deployment-id": number | string;
/** @description The number that identifies the pull request. */
- readonly "pull-number": number;
+ "pull-number": number;
/** @description The unique identifier of the review. */
- readonly "review-id": number;
+ "review-id": number;
/** @description The unique identifier of the asset. */
- readonly "asset-id": number;
+ "asset-id": number;
/** @description The unique identifier of the release. */
- readonly "release-id": number;
- /** @description The unique identifier of the tag protection. */
- readonly "tag-protection-id": number;
+ "release-id": number;
/** @description The time frame to display results for. */
- readonly per: "day" | "week";
+ per: "day" | "week";
/** @description A repository ID. Only return repositories with an ID greater than this ID. */
- readonly "since-repo": number;
+ "since-repo": number;
/** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */
- readonly order: "desc" | "asc";
+ order: "desc" | "asc";
+ /**
+ * @description Set to `true` to use advanced search.
+ * Example: `http://api.github.com/search/issues?q={query}&advanced_search=true`
+ */
+ "issues-advanced-search": string;
/** @description The unique identifier of the team. */
- readonly "team-id": number;
+ "team-id": number;
/** @description ID of the Repository to filter on */
- readonly "repository-id-in-query": number;
+ "repository-id-in-query": number;
/** @description The ID of the export operation, or `latest`. Currently only `latest` is currently supported. */
- readonly "export-id": string;
+ "export-id": string;
/** @description The unique identifier of the GPG key. */
- readonly "gpg-key-id": number;
+ "gpg-key-id": number;
/** @description Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "since-repo-date": string;
+ "since-repo-date": string;
/** @description Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly "before-repo-date": string;
+ "before-repo-date": string;
/** @description The unique identifier of the SSH signing key. */
- readonly "ssh-signing-key-id": number;
+ "ssh-signing-key-id": number;
/** @description The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. */
- readonly "sort-starred": "created" | "updated";
+ "sort-starred": "created" | "updated";
+ /** @description The unique identifier of the user. */
+ "user-id": string;
};
requestBodies: never;
headers: {
/** @example ; rel="next", ; rel="last" */
- readonly link: string;
+ link: string;
/** @example text/html */
- readonly "content-type": string;
+ "content-type": string;
/** @example 0.17.4 */
- readonly "x-common-marker-version": string;
+ "x-common-marker-version": string;
/** @example 5000 */
- readonly "x-rate-limit-limit": number;
+ "x-rate-limit-limit": number;
/** @example 4999 */
- readonly "x-rate-limit-remaining": number;
+ "x-rate-limit-remaining": number;
/** @example 1590701888 */
- readonly "x-rate-limit-reset": number;
+ "x-rate-limit-reset": number;
/** @example https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D */
- readonly location: string;
+ location: string;
};
pathItems: never;
-};
+}
export type $defs = Record;
export interface operations {
- readonly "meta/root": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "meta/root": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["root"];
+ "application/json": components["schemas"]["root"];
};
};
};
};
- readonly "security-advisories/list-global-advisories": {
- readonly parameters: {
- readonly query?: {
+ "security-advisories/list-global-advisories": {
+ parameters: {
+ query?: {
/** @description If specified, only advisories with this GHSA (GitHub Security Advisory) identifier will be returned. */
- readonly ghsa_id?: string;
+ ghsa_id?: string;
/** @description If specified, only advisories of this type will be returned. By default, a request with no other parameters defined will only return reviewed advisories that are not malware. */
- readonly type?: "reviewed" | "malware" | "unreviewed";
+ type?: "reviewed" | "malware" | "unreviewed";
/** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */
- readonly cve_id?: string;
+ cve_id?: string;
/** @description If specified, only advisories for these ecosystems will be returned. */
- readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"];
+ ecosystem?: components["schemas"]["security-advisory-ecosystems"];
/** @description If specified, only advisories with these severities will be returned. */
- readonly severity?: "unknown" | "low" | "medium" | "high" | "critical";
+ severity?: "unknown" | "low" | "medium" | "high" | "critical";
/**
* @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned.
*
* Example: `cwes=79,284,22` or `cwes[]=79&cwes[]=284&cwes[]=22`
*/
- readonly cwes?: string | readonly string[];
+ cwes?: string | string[];
/** @description Whether to only return advisories that have been withdrawn. */
- readonly is_withdrawn?: boolean;
+ is_withdrawn?: boolean;
/**
* @description If specified, only return advisories that affect any of `package` or `package@version`. A maximum of 1000 packages can be specified.
* If the query parameter causes the URL to exceed the maximum URL length supported by your client, you must specify fewer packages.
*
- * Example: `affects=package1,package2@1.0.0,package3@^2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`
+ * Example: `affects=package1,package2@1.0.0,package3@2.0.0` or `affects[]=package1&affects[]=package2@1.0.0`
*/
- readonly affects?: string | readonly string[];
+ affects?: string | string[];
/**
* @description If specified, only return advisories that were published on a date or date range.
*
* For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
*/
- readonly published?: string;
+ published?: string;
/**
* @description If specified, only return advisories that were updated on a date or date range.
*
* For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
*/
- readonly updated?: string;
+ updated?: string;
/**
* @description If specified, only show advisories that were updated or published on a date or date range.
*
* For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)."
*/
- readonly modified?: string;
+ modified?: string;
/**
* @description If specified, only return advisories that have an EPSS percentage score that matches the provided value.
* The EPSS percentage represents the likelihood of a CVE being exploited.
*/
- readonly epss_percentage?: string;
+ epss_percentage?: string;
/**
* @description If specified, only return advisories that have an EPSS percentile score that matches the provided value.
* The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
*/
- readonly epss_percentile?: string;
+ epss_percentile?: string;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
/** @description The property to sort the results by. */
- readonly sort?: "updated" | "published" | "epss_percentage" | "epss_percentile";
+ sort?: "updated" | "published" | "epss_percentage" | "epss_percentile";
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["global-advisory"][];
+ "application/json": components["schemas"]["global-advisory"][];
};
};
- readonly 422: components["responses"]["validation_failed_simple"];
+ 422: components["responses"]["validation_failed_simple"];
/** @description Too many requests */
- readonly 429: {
+ 429: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "security-advisories/get-global-advisory": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "security-advisories/get-global-advisory": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */
- readonly ghsa_id: components["parameters"]["ghsa_id"];
+ ghsa_id: components["parameters"]["ghsa_id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["global-advisory"];
+ "application/json": components["schemas"]["global-advisory"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/get-authenticated": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "apps/get-authenticated": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["integration"];
+ "application/json": components["schemas"]["integration"];
};
};
};
};
- readonly "apps/create-from-manifest": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly code: string;
+ "apps/create-from-manifest": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ code: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["integration"] & ({
- readonly client_id: string;
- readonly client_secret: string;
- readonly webhook_secret: string | null;
- readonly pem: string;
+ "application/json": components["schemas"]["integration"] & ({
+ client_id: string;
+ client_secret: string;
+ webhook_secret: string | null;
+ pem: string;
} & {
- readonly [key: string]: unknown;
+ [key: string]: unknown;
});
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "apps/get-webhook-config-for-app": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "apps/get-webhook-config-for-app": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "apps/update-webhook-config-for-app": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "apps/update-webhook-config-for-app": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ requestBody: {
+ content: {
+ "application/json": {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "apps/list-webhook-deliveries": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-webhook-deliveries": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- readonly cursor?: components["parameters"]["cursor"];
+ cursor?: components["parameters"]["cursor"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["hook-delivery-item"][];
+ "application/json": components["schemas"]["hook-delivery-item"][];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/get-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly delivery_id: components["parameters"]["delivery-id"];
+ "apps/get-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook-delivery"];
+ "application/json": components["schemas"]["hook-delivery"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/redeliver-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly delivery_id: components["parameters"]["delivery-id"];
+ "apps/redeliver-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ requestBody?: never;
+ responses: {
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/list-installation-requests-for-authenticated-app": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-installation-requests-for-authenticated-app": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description List of integration installation requests */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["integration-installation-request"][];
+ "application/json": components["schemas"]["integration-installation-request"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
};
};
- readonly "apps/list-installations": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-installations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
- readonly outdated?: string;
+ since?: components["parameters"]["since"];
+ outdated?: string;
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description The permissions the installation has are included under the `permissions` key. */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["installation"][];
+ "application/json": components["schemas"]["installation"][];
};
};
};
};
- readonly "apps/get-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/get-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the installation. */
- readonly installation_id: components["parameters"]["installation-id"];
+ installation_id: components["parameters"]["installation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["installation"];
+ "application/json": components["schemas"]["installation"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/delete-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/delete-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the installation. */
- readonly installation_id: components["parameters"]["installation-id"];
+ installation_id: components["parameters"]["installation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/create-installation-access-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/create-installation-access-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the installation. */
- readonly installation_id: components["parameters"]["installation-id"];
+ installation_id: components["parameters"]["installation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description List of repository names that the token should have access to */
- readonly repositories?: readonly string[];
+ repositories?: string[];
/**
* @description List of repository IDs that the token should have access to
* @example [
* 1
* ]
*/
- readonly repository_ids?: readonly number[];
- readonly permissions?: components["schemas"]["app-permissions"];
+ repository_ids?: number[];
+ permissions?: components["schemas"]["app-permissions"];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["installation-token"];
+ "application/json": components["schemas"]["installation-token"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/suspend-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/suspend-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the installation. */
- readonly installation_id: components["parameters"]["installation-id"];
+ installation_id: components["parameters"]["installation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/unsuspend-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/unsuspend-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the installation. */
- readonly installation_id: components["parameters"]["installation-id"];
+ installation_id: components["parameters"]["installation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/delete-authorization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/delete-authorization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The client ID of the GitHub app. */
- readonly client_id: components["parameters"]["client-id"];
+ client_id: components["parameters"]["client-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The OAuth access token used to authenticate to the GitHub API. */
- readonly access_token: string;
+ access_token: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/check-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/check-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The client ID of the GitHub app. */
- readonly client_id: components["parameters"]["client-id"];
+ client_id: components["parameters"]["client-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The access_token of the OAuth or GitHub application. */
- readonly access_token: string;
+ access_token: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authorization"];
+ "application/json": components["schemas"]["authorization"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/delete-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/delete-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The client ID of the GitHub app. */
- readonly client_id: components["parameters"]["client-id"];
+ client_id: components["parameters"]["client-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The OAuth access token used to authenticate to the GitHub API. */
- readonly access_token: string;
+ access_token: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/reset-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/reset-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The client ID of the GitHub app. */
- readonly client_id: components["parameters"]["client-id"];
+ client_id: components["parameters"]["client-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The access_token of the OAuth or GitHub application. */
- readonly access_token: string;
+ access_token: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authorization"];
+ "application/json": components["schemas"]["authorization"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/scope-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/scope-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The client ID of the GitHub app. */
- readonly client_id: components["parameters"]["client-id"];
+ client_id: components["parameters"]["client-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The access token used to authenticate to the GitHub API.
* @example e72e16c7e42f292c6912e7710c838347ae178b4a
*/
- readonly access_token: string;
+ access_token: string;
/**
* @description The name of the user or organization to scope the user access token to. **Required** unless `target_id` is specified.
* @example octocat
*/
- readonly target?: string;
+ target?: string;
/**
* @description The ID of the user or organization to scope the user access token to. **Required** unless `target` is specified.
* @example 1
*/
- readonly target_id?: number;
+ target_id?: number;
/** @description The list of repository names to scope the user access token to. `repositories` may not be specified if `repository_ids` is specified. */
- readonly repositories?: readonly string[];
+ repositories?: string[];
/**
* @description The list of repository IDs to scope the user access token to. `repository_ids` may not be specified if `repositories` is specified.
* @example [
* 1
* ]
*/
- readonly repository_ids?: readonly number[];
- readonly permissions?: components["schemas"]["app-permissions"];
+ repository_ids?: number[];
+ permissions?: components["schemas"]["app-permissions"];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authorization"];
+ "application/json": components["schemas"]["authorization"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/get-by-slug": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly app_slug: components["parameters"]["app-slug"];
+ "apps/get-by-slug": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ app_slug: components["parameters"]["app-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["integration"];
+ "application/json": components["schemas"]["integration"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "classroom/get-an-assignment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "classroom/get-an-assignment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the classroom assignment. */
- readonly assignment_id: components["parameters"]["assignment-id"];
+ assignment_id: components["parameters"]["assignment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["classroom-assignment"];
+ "application/json": components["schemas"]["classroom-assignment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "classroom/list-accepted-assignments-for-an-assignment": {
- readonly parameters: {
- readonly query?: {
+ "classroom/list-accepted-assignments-for-an-assignment": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the classroom assignment. */
- readonly assignment_id: components["parameters"]["assignment-id"];
+ assignment_id: components["parameters"]["assignment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["classroom-accepted-assignment"][];
+ "application/json": components["schemas"]["classroom-accepted-assignment"][];
};
};
};
};
- readonly "classroom/get-assignment-grades": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "classroom/get-assignment-grades": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the classroom assignment. */
- readonly assignment_id: components["parameters"]["assignment-id"];
+ assignment_id: components["parameters"]["assignment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["classroom-assignment-grade"][];
+ "application/json": components["schemas"]["classroom-assignment-grade"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "classroom/list-classrooms": {
- readonly parameters: {
- readonly query?: {
+ "classroom/list-classrooms": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-classroom"][];
+ "application/json": components["schemas"]["simple-classroom"][];
};
};
};
};
- readonly "classroom/get-a-classroom": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "classroom/get-a-classroom": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the classroom. */
- readonly classroom_id: components["parameters"]["classroom-id"];
+ classroom_id: components["parameters"]["classroom-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["classroom"];
+ "application/json": components["schemas"]["classroom"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "classroom/list-assignments-for-a-classroom": {
- readonly parameters: {
- readonly query?: {
+ "classroom/list-assignments-for-a-classroom": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the classroom. */
- readonly classroom_id: components["parameters"]["classroom-id"];
+ classroom_id: components["parameters"]["classroom-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-classroom-assignment"][];
+ "application/json": components["schemas"]["simple-classroom-assignment"][];
};
};
};
};
- readonly "codes-of-conduct/get-all-codes-of-conduct": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "codes-of-conduct/get-all-codes-of-conduct": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-of-conduct"][];
+ "application/json": components["schemas"]["code-of-conduct"][];
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "codes-of-conduct/get-conduct-code": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly key: string;
+ "codes-of-conduct/get-conduct-code": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ key: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-of-conduct"];
+ "application/json": components["schemas"]["code-of-conduct"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "credentials/revoke": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A list of credentials to be revoked, up to 1000 per request. */
+ credentials: string[];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 404: components["responses"]["not_found"];
+ };
+ responses: {
+ 202: components["responses"]["accepted"];
+ 422: components["responses"]["validation_failed_simple"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "emojis/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "emojis/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly [key: string]: string;
+ "application/json": {
+ [key: string]: string;
};
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ "actions/get-actions-cache-retention-limit-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-actions-cache-retention-limit-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-enterprise"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/get-actions-cache-storage-limit-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/get-configurations-for-enterprise": {
- readonly parameters: {
- readonly query?: {
+ "actions/set-actions-cache-storage-limit-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-enterprise"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "code-security/get-configurations-for-enterprise": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
};
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-security-configuration"][];
+ "application/json": components["schemas"]["code-security-configuration"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/create-configuration-for-enterprise": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/create-configuration-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the code security configuration. Must be unique within the enterprise. */
- readonly name: string;
+ name: string;
/** @description A description of the code security configuration */
- readonly description: string;
+ description: string;
/**
- * @description The enablement status of GitHub Advanced Security
+ * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
+ *
+ * > [!WARNING]
+ * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.
* @default disabled
* @enum {string}
*/
- readonly advanced_security?: "enabled" | "disabled";
+ advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection";
+ /**
+ * @description The enablement status of GitHub Code Security features.
+ * @enum {string}
+ */
+ code_security?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependency Graph
* @default enabled
* @enum {string}
*/
- readonly dependency_graph?: "enabled" | "disabled" | "not_set";
+ dependency_graph?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Automatic dependency submission
* @default disabled
* @enum {string}
*/
- readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
/** @description Feature options for Automatic dependency submission */
- readonly dependency_graph_autosubmit_action_options?: {
+ dependency_graph_autosubmit_action_options?: {
/**
* @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.
* @default false
*/
- readonly labeled_runners?: boolean;
+ labeled_runners?: boolean;
};
/**
* @description The enablement status of Dependabot alerts
* @default disabled
* @enum {string}
*/
- readonly dependabot_alerts?: "enabled" | "disabled" | "not_set";
+ dependabot_alerts?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependabot security updates
* @default disabled
* @enum {string}
*/
- readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ code_scanning_options?: components["schemas"]["code-scanning-options"];
/**
* @description The enablement status of code scanning default setup
* @default disabled
* @enum {string}
*/
- readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
- readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
+ code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ /**
+ * @description The enablement status of code scanning delegated alert dismissal
+ * @default disabled
+ * @enum {string}
+ */
+ code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of GitHub Secret Protection features.
+ * @enum {string}
+ */
+ secret_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning
* @default disabled
* @enum {string}
*/
- readonly secret_scanning?: "enabled" | "disabled" | "not_set";
+ secret_scanning?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning push protection
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
+ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning validity checks
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
+ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning non provider patterns
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Copilot secret scanning
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning delegated alert dismissal
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning extended metadata
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of private vulnerability reporting
* @default disabled
* @enum {string}
*/
- readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
+ private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
/**
* @description The enforcement status for a security configuration
* @default enforced
* @enum {string}
*/
- readonly enforcement?: "enforced" | "unenforced";
+ enforcement?: "enforced" | "unenforced";
};
};
};
- readonly responses: {
+ responses: {
/** @description Successfully created code security configuration */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/get-default-configurations-for-enterprise": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/get-default-configurations-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-default-configurations"];
+ "application/json": components["schemas"]["code-security-default-configurations"];
};
};
};
};
- readonly "code-security/get-single-configuration-for-enterprise": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/get-single-configuration-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/delete-configuration-for-enterprise": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/delete-configuration-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- };
- };
- readonly "code-security/update-enterprise-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ configuration_id: components["parameters"]["configuration-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 204: components["responses"]["no_content"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ };
+ };
+ "code-security/update-enterprise-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the code security configuration. Must be unique across the enterprise. */
- readonly name?: string;
+ name?: string;
/** @description A description of the code security configuration */
- readonly description?: string;
+ description?: string;
/**
- * @description The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.
+ * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
+ *
+ * > [!WARNING]
+ * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.
* @enum {string}
*/
- readonly advanced_security?: "enabled" | "disabled";
+ advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection";
+ /**
+ * @description The enablement status of GitHub Code Security features.
+ * @enum {string}
+ */
+ code_security?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependency Graph
* @enum {string}
*/
- readonly dependency_graph?: "enabled" | "disabled" | "not_set";
+ dependency_graph?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Automatic dependency submission
* @enum {string}
*/
- readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
/** @description Feature options for Automatic dependency submission */
- readonly dependency_graph_autosubmit_action_options?: {
+ dependency_graph_autosubmit_action_options?: {
/** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */
- readonly labeled_runners?: boolean;
+ labeled_runners?: boolean;
};
/**
* @description The enablement status of Dependabot alerts
* @enum {string}
*/
- readonly dependabot_alerts?: "enabled" | "disabled" | "not_set";
+ dependabot_alerts?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependabot security updates
* @enum {string}
*/
- readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ dependabot_security_updates?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of code scanning default setup
* @enum {string}
*/
- readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
- readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
+ code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_options?: components["schemas"]["code-scanning-options"];
+ /**
+ * @description The enablement status of code scanning delegated alert dismissal
+ * @default disabled
+ * @enum {string}
+ */
+ code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of GitHub Secret Protection features.
+ * @enum {string}
+ */
+ secret_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning
* @enum {string}
*/
- readonly secret_scanning?: "enabled" | "disabled" | "not_set";
+ secret_scanning?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning push protection
* @enum {string}
*/
- readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
+ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning validity checks
* @enum {string}
*/
- readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
+ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning non-provider patterns
* @enum {string}
*/
- readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Copilot secret scanning
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning delegated alert dismissal
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning extended metadata
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of private vulnerability reporting
* @enum {string}
*/
- readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
+ private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
/**
* @description The enforcement status for a security configuration
* @enum {string}
*/
- readonly enforcement?: "enforced" | "unenforced";
+ enforcement?: "enforced" | "unenforced";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "code-security/attach-enterprise-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/attach-enterprise-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
- * @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`
+ * @description The type of repositories to attach the configuration to.
* @enum {string}
*/
- readonly scope: "all" | "all_without_configurations";
+ scope: "all" | "all_without_configurations";
};
};
};
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "code-security/set-configuration-as-default-for-enterprise": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ "code-security/set-configuration-as-default-for-enterprise": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Specify which types of repository this security configuration should be applied to by default.
* @enum {string}
*/
- readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
+ default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
};
};
};
- readonly responses: {
+ responses: {
/** @description Default successfully changed. */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description Specifies which types of repository this security configuration is applied to by default.
* @enum {string}
*/
- readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
- readonly configuration?: components["schemas"]["code-security-configuration"];
+ default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
+ configuration?: components["schemas"]["code-security-configuration"];
};
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/get-repositories-for-enterprise-configuration": {
- readonly parameters: {
- readonly query?: {
+ "code-security/get-repositories-for-enterprise-configuration": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/**
* @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.
*
* Can be: `all`, `attached`, `attaching`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`
*/
- readonly status?: string;
+ status?: string;
};
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][];
+ "application/json": components["schemas"]["code-security-configuration-repositories"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "dependabot/list-alerts-for-enterprise": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-alerts-for-enterprise": {
+ parameters: {
+ query?: {
/**
* @description A comma-separated list of states. If specified, only alerts with these states will be returned.
*
* Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
*/
- readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
/**
* @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
*
* Can be: `low`, `medium`, `high`, `critical`
*/
- readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
/**
* @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
*
* Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
*/
- readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
/** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
/**
* @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
* - An exact number (`n`)
@@ -89444,203 +94784,693 @@ export interface operations {
*
* Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
*/
- readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ /**
+ * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
+ * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
+ */
+ has?: components["parameters"]["dependabot-alert-comma-separated-has"];
+ /**
+ * @description Filter alerts by assignees.
+ * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"];
/** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */
- readonly scope?: components["parameters"]["dependabot-alert-scope"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
/**
* @description The property by which to sort the results.
* `created` means when the alert was created.
* `updated` means when the alert's state last changed.
* `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.
*/
- readonly sort?: components["parameters"]["dependabot-alert-sort"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
- * This parameter must not be used in combination with `last`.
- * Instead, use `per_page` in combination with `after` to fetch the first page of results.
- */
- readonly first?: components["parameters"]["pagination-first"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result.
- * This parameter must not be used in combination with `first`.
- * Instead, use `per_page` in combination with `before` to fetch the last page of results.
- */
- readonly last?: components["parameters"]["pagination-last"];
+ after?: components["parameters"]["pagination-after"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][];
+ "application/json": components["schemas"]["dependabot-alert-with-repository"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "secret-scanning/list-alerts-for-enterprise": {
- readonly parameters: {
- readonly query?: {
- /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- readonly state?: components["parameters"]["secret-scanning-alert-state"];
- /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */
- readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
- /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"];
- /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- readonly sort?: components["parameters"]["secret-scanning-alert-sort"];
- /** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ "enterprise-teams/list": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
- /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
- readonly validity?: components["parameters"]["secret-scanning-alert-validity"];
- /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */
- readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"];
- /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */
- readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"];
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
- /** @description The slug version of the enterprise name. You can also substitute this value with the enterprise id. */
- readonly enterprise: components["parameters"]["enterprise"];
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][];
+ "application/json": components["schemas"]["enterprise-team"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/list-public-events": {
- readonly parameters: {
- readonly query?: {
+ "enterprise-teams/create": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the team. */
+ name: string;
+ /** @description A description of the team. */
+ description?: string | null;
+ /**
+ * @description Retired: this field is no longer supported.
+ * Whether the enterprise team should be reflected in each organization.
+ * This value cannot be set.
+ * @default disabled
+ * @enum {string}
+ */
+ sync_to_organizations?: "all" | "disabled";
+ /**
+ * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.
+ * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team.
+ * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments) endpoint.
+ * `all`: The team is assigned to all current and future organizations in the enterprise.
+ * @default disabled
+ * @enum {string}
+ */
+ organization_selection_type?: "disabled" | "selected" | "all";
+ /** @description The ID of the IdP group to assign team membership with. You can get this value from the [REST API endpoints for SCIM](https://docs.github.com/rest/scim#list-provisioned-scim-groups-for-an-enterprise). */
+ group_id?: string | null;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["enterprise-team"];
+ };
+ };
+ };
+ };
+ "enterprise-team-memberships/list": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
+ };
+ };
+ };
+ };
+ "enterprise-team-memberships/bulk-add": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The GitHub user handles to add to the team. */
+ usernames: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successfully added team members. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
+ };
+ };
+ };
+ };
+ "enterprise-team-memberships/bulk-remove": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The GitHub user handles to be removed from the team. */
+ usernames: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successfully removed team members. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"][];
+ };
+ };
+ };
+ };
+ "enterprise-team-memberships/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The handle for the GitHub user account. */
+ username: components["parameters"]["username"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description User is a member of the enterprise team. */
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["event"][];
+ "application/json": components["schemas"]["simple-user"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 503: components["responses"]["service_unavailable"];
};
};
- readonly "activity/get-feeds": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "enterprise-team-memberships/add": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The handle for the GitHub user account. */
+ username: components["parameters"]["username"];
+ };
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
+ /** @description Successfully added team member */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["simple-user"];
+ };
+ };
+ };
+ };
+ "enterprise-team-memberships/remove": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The handle for the GitHub user account. */
+ username: components["parameters"]["username"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "enterprise-team-organizations/get-assignments": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description An array of organizations the team is assigned to */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-simple"][];
+ };
+ };
+ };
+ };
+ "enterprise-team-organizations/bulk-add": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Organization slug to assign the team to. */
+ organization_slugs: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successfully assigned the enterprise team to organizations. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-simple"][];
+ };
+ };
+ };
+ };
+ "enterprise-team-organizations/bulk-remove": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Organization slug to unassign the team from. */
+ organization_slugs: string[];
+ };
+ };
+ };
+ responses: {
+ /** @description Successfully unassigned the enterprise team from organizations. */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "enterprise-team-organizations/get-assignment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description The team is assigned to the organization */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-simple"];
+ };
+ };
+ /** @description The team is not assigned to the organization */
+ 404: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "enterprise-team-organizations/add": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Successfully assigned the enterprise team to the organization. */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-simple"];
+ };
+ };
+ };
+ };
+ "enterprise-team-organizations/delete": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug version of the enterprise team name. You can also substitute this value with the enterprise team id. */
+ "enterprise-team": components["parameters"]["enterprise-team"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Successfully unassigned the enterprise team from the organization. */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "enterprise-teams/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug of the team name. */
+ team_slug: components["parameters"]["team-slug"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["enterprise-team"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "enterprise-teams/delete": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug of the team name. */
+ team_slug: components["parameters"]["team-slug"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "enterprise-teams/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The slug version of the enterprise name. */
+ enterprise: components["parameters"]["enterprise"];
+ /** @description The slug of the team name. */
+ team_slug: components["parameters"]["team-slug"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A new name for the team. */
+ name?: string | null;
+ /** @description A new description for the team. */
+ description?: string | null;
+ /**
+ * @description Retired: this field is no longer supported.
+ * Whether the enterprise team should be reflected in each organization.
+ * This value cannot be changed.
+ * @default disabled
+ * @enum {string}
+ */
+ sync_to_organizations?: "all" | "disabled";
+ /**
+ * @description Specifies which organizations in the enterprise should have access to this team. Can be one of `disabled`, `selected`, or `all`.
+ * `disabled`: The team is not assigned to any organizations. This is the default when you create a new team.
+ * `selected`: The team is assigned to specific organizations. You can then use the [add organization assignments API](https://docs.github.com/rest/enterprise-teams/enterprise-team-organizations#add-organization-assignments).
+ * `all`: The team is assigned to all current and future organizations in the enterprise.
+ * @default disabled
+ * @enum {string}
+ */
+ organization_selection_type?: "disabled" | "selected" | "all";
+ /** @description The ID of the IdP group to assign team membership with. The new IdP group will replace the existing one, or replace existing direct members if the team isn't currently linked to an IdP group. */
+ group_id?: string | null;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["enterprise-team"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "activity/list-public-events": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["public-events-per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["feed"];
+ "application/json": components["schemas"]["event"][];
};
};
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "gists/list": {
- readonly parameters: {
- readonly query?: {
+ "activity/get-feeds": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["feed"];
+ };
+ };
+ };
+ };
+ "gists/list": {
+ parameters: {
+ query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["base-gist"][];
+ "application/json": components["schemas"]["base-gist"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "gists/create": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "gists/create": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Description of the gist
* @example Example Ruby script
*/
- readonly description?: string;
+ description?: string;
/**
* @description Names and content for the files that make up the gist
* @example {
@@ -89649,164 +95479,164 @@ export interface operations {
* }
* }
*/
- readonly files: {
- readonly [key: string]: {
+ files: {
+ [key: string]: {
/** @description Content of the file */
- readonly content: string;
+ content: string;
};
};
- readonly public?: boolean | ("true" | "false");
+ public?: boolean | ("true" | "false");
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/gists/aa5a315d61ae9438b18d */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-simple"];
+ "application/json": components["schemas"]["gist-simple"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "gists/list-public": {
- readonly parameters: {
- readonly query?: {
+ "gists/list-public": {
+ parameters: {
+ query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["base-gist"][];
+ "application/json": components["schemas"]["base-gist"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "gists/list-starred": {
- readonly parameters: {
- readonly query?: {
+ "gists/list-starred": {
+ parameters: {
+ query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["base-gist"][];
+ "application/json": components["schemas"]["base-gist"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "gists/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-simple"];
+ "application/json": components["schemas"]["gist-simple"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden_gist"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden_gist"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/delete": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/delete": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The description of the gist.
* @example Example Ruby script
*/
- readonly description?: string;
+ description?: string;
/**
* @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`.
@@ -89820,1336 +95650,1776 @@ export interface operations {
* }
* }
*/
- readonly files?: {
- readonly [key: string]: {
+ files?: {
+ [key: string]: {
/** @description The new content of the file. */
- readonly content?: string;
+ content?: string;
/** @description The new filename for the file. */
- readonly filename?: string | null;
+ filename?: string | null;
} | null;
};
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-simple"];
+ "application/json": components["schemas"]["gist-simple"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "gists/list-comments": {
- readonly parameters: {
- readonly query?: {
+ "gists/list-comments": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["gist-comment"][];
+ "application/json": components["schemas"]["gist-comment"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/create-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/create-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The comment text.
* @example Body of the attachment
*/
- readonly body: string;
+ body: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-comment"];
+ "application/json": components["schemas"]["gist-comment"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/get-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/get-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-comment"];
+ "application/json": components["schemas"]["gist-comment"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden_gist"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden_gist"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/delete-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/delete-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/update-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/update-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The comment text.
* @example Body of the attachment
*/
- readonly body: string;
+ body: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-comment"];
+ "application/json": components["schemas"]["gist-comment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/list-commits": {
- readonly parameters: {
- readonly query?: {
+ "gists/list-commits": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
/** @example ; rel="next" */
- readonly Link?: string;
- readonly [name: string]: unknown;
+ Link?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["gist-commit"][];
+ "application/json": components["schemas"]["gist-commit"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/list-forks": {
- readonly parameters: {
- readonly query?: {
+ "gists/list-forks": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["gist-simple"][];
+ "application/json": components["schemas"]["gist-simple"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/fork": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/fork": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/gists/aa5a315d61ae9438b18d */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["base-gist"];
+ "application/json": components["schemas"]["base-gist"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "gists/check-is-starred": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/check-is-starred": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if gist is starred */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
/** @description Not Found if gist is not starred */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": Record;
+ "application/json": Record;
};
};
};
};
- readonly "gists/star": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/star": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/unstar": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/unstar": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
+ gist_id: components["parameters"]["gist-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "gists/get-revision": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "gists/get-revision": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the gist. */
- readonly gist_id: components["parameters"]["gist-id"];
- readonly sha: string;
+ gist_id: components["parameters"]["gist-id"];
+ sha: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gist-simple"];
+ "application/json": components["schemas"]["gist-simple"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "gitignore/get-all-templates": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "gitignore/get-all-templates": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly string[];
+ "application/json": string[];
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "gitignore/get-template": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly name: string;
+ "gitignore/get-template": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["gitignore-template"];
+ "application/json": components["schemas"]["gitignore-template"];
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "apps/list-repos-accessible-to-installation": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-repos-accessible-to-installation": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["repository"][];
/** @example selected */
- readonly repository_selection?: string;
+ repository_selection?: string;
};
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "apps/revoke-installation-access-token": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "apps/revoke-installation-access-token": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/list": {
- readonly parameters: {
- readonly query?: {
+ "issues/list": {
+ parameters: {
+ query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
- readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
+ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
/** @description Indicates the state of the issues to return. */
- readonly state?: "open" | "closed" | "all";
+ state?: "open" | "closed" | "all";
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
- readonly labels?: components["parameters"]["labels"];
+ labels?: components["parameters"]["labels"];
/** @description What to sort results by. */
- readonly sort?: "created" | "updated" | "comments";
+ sort?: "created" | "updated" | "comments";
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
- readonly collab?: boolean;
- readonly orgs?: boolean;
- readonly owned?: boolean;
- readonly pulls?: boolean;
+ since?: components["parameters"]["since"];
+ collab?: boolean;
+ orgs?: boolean;
+ owned?: boolean;
+ pulls?: boolean;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "licenses/get-all-commonly-used": {
- readonly parameters: {
- readonly query?: {
- readonly featured?: boolean;
+ "licenses/get-all-commonly-used": {
+ parameters: {
+ query?: {
+ featured?: boolean;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["license-simple"][];
+ "application/json": components["schemas"]["license-simple"][];
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "licenses/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- readonly license: string;
+ "licenses/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ license: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["license"];
+ "application/json": components["schemas"]["license"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "markdown/render": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "markdown/render": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The Markdown text to render in HTML. */
- readonly text: string;
+ text: string;
/**
* @description The rendering mode.
* @default markdown
* @example markdown
* @enum {string}
*/
- readonly mode?: "markdown" | "gfm";
+ mode?: "markdown" | "gfm";
/** @description The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository. */
- readonly context?: string;
+ context?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly "Content-Type": components["headers"]["content-type"];
+ "Content-Type": components["headers"]["content-type"];
/** @example 279 */
- readonly "Content-Length"?: string;
- readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
- readonly [name: string]: unknown;
+ "Content-Length"?: string;
+ "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
+ [name: string]: unknown;
};
content: {
- readonly "text/html": string;
+ "text/html": string;
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "markdown/render-raw": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "markdown/render-raw": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "text/plain": string;
- readonly "text/x-markdown": string;
+ requestBody?: {
+ content: {
+ "text/plain": string;
+ "text/x-markdown": string;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
- readonly [name: string]: unknown;
+ "X-CommonMarker-Version": components["headers"]["x-common-marker-version"];
+ [name: string]: unknown;
};
content: {
- readonly "text/html": string;
+ "text/html": string;
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "apps/get-subscription-plan-for-account": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/get-subscription-plan-for-account": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description account_id parameter */
- readonly account_id: components["parameters"]["account-id"];
+ account_id: components["parameters"]["account-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["marketplace-purchase"];
+ "application/json": components["schemas"]["marketplace-purchase"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
+ 401: components["responses"]["requires_authentication"];
/** @description Not Found when the account has not purchased the listing */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "apps/list-plans": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-plans": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][];
+ "application/json": components["schemas"]["marketplace-listing-plan"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "apps/list-accounts-for-plan": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-accounts-for-plan": {
+ parameters: {
+ query?: {
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["sort"];
+ sort?: components["parameters"]["sort"];
/** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
- readonly direction?: "asc" | "desc";
+ direction?: "asc" | "desc";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the plan. */
- readonly plan_id: components["parameters"]["plan-id"];
+ plan_id: components["parameters"]["plan-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["marketplace-purchase"][];
+ "application/json": components["schemas"]["marketplace-purchase"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 401: components["responses"]["requires_authentication"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "apps/get-subscription-plan-for-account-stubbed": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/get-subscription-plan-for-account-stubbed": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description account_id parameter */
- readonly account_id: components["parameters"]["account-id"];
+ account_id: components["parameters"]["account-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["marketplace-purchase"];
+ "application/json": components["schemas"]["marketplace-purchase"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
+ 401: components["responses"]["requires_authentication"];
/** @description Not Found when the account has not purchased the listing */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "apps/list-plans-stubbed": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-plans-stubbed": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["marketplace-listing-plan"][];
+ "application/json": components["schemas"]["marketplace-listing-plan"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
+ 401: components["responses"]["requires_authentication"];
};
};
- readonly "apps/list-accounts-for-plan-stubbed": {
- readonly parameters: {
- readonly query?: {
+ "apps/list-accounts-for-plan-stubbed": {
+ parameters: {
+ query?: {
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["sort"];
+ sort?: components["parameters"]["sort"];
/** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */
- readonly direction?: "asc" | "desc";
+ direction?: "asc" | "desc";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The unique identifier of the plan. */
- readonly plan_id: components["parameters"]["plan-id"];
+ plan_id: components["parameters"]["plan-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["marketplace-purchase"][];
+ "application/json": components["schemas"]["marketplace-purchase"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
+ 401: components["responses"]["requires_authentication"];
};
};
- readonly "meta/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "meta/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-overview"];
+ "application/json": components["schemas"]["api-overview"];
};
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
};
};
- readonly "activity/list-public-events-for-repo-network": {
- readonly parameters: {
- readonly query?: {
+ "activity/list-public-events-for-repo-network": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["event"][];
+ "application/json": components["schemas"]["event"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 301: components["responses"]["moved_permanently"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "activity/list-notifications-for-authenticated-user": {
- readonly parameters: {
- readonly query?: {
+ "activity/list-notifications-for-authenticated-user": {
+ parameters: {
+ query?: {
/** @description If `true`, show notifications marked as read. */
- readonly all?: components["parameters"]["all"];
+ all?: components["parameters"]["all"];
/** @description If `true`, only shows notifications in which the user is directly participating or mentioned. */
- readonly participating?: components["parameters"]["participating"];
+ participating?: components["parameters"]["participating"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly before?: components["parameters"]["before"];
+ before?: components["parameters"]["before"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["thread"][];
+ "application/json": components["schemas"]["thread"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "activity/mark-notifications-as-read": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ "activity/mark-notifications-as-read": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* Format: date-time
* @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.
*/
- readonly last_read_at?: string;
+ last_read_at?: string;
/** @description Whether the notification has been read. */
- readonly read?: boolean;
+ read?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly message?: string;
+ "application/json": {
+ message?: string;
};
};
};
/** @description Reset Content */
- readonly 205: {
+ 205: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/get-thread": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/get-thread": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["thread"];
+ "application/json": components["schemas"]["thread"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/mark-thread-as-done": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/mark-thread-as-done": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description No content */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "activity/mark-thread-as-read": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/mark-thread-as-read": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Reset Content */
- readonly 205: {
+ 205: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/get-thread-subscription-for-authenticated-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/get-thread-subscription-for-authenticated-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["thread-subscription"];
+ "application/json": components["schemas"]["thread-subscription"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/set-thread-subscription": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/set-thread-subscription": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description Whether to block all notifications from a thread.
* @default false
*/
- readonly ignored?: boolean;
+ ignored?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["thread-subscription"];
+ "application/json": components["schemas"]["thread-subscription"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/delete-thread-subscription": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "activity/delete-thread-subscription": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */
- readonly thread_id: components["parameters"]["thread-id"];
+ thread_id: components["parameters"]["thread-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "meta/get-octocat": {
- readonly parameters: {
- readonly query?: {
+ "meta/get-octocat": {
+ parameters: {
+ query?: {
/** @description The words to show in Octocat's speech bubble */
- readonly s?: string;
+ s?: string;
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/octocat-stream": string;
+ "application/octocat-stream": string;
};
};
};
};
- readonly "orgs/list": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list": {
+ parameters: {
+ query?: {
/** @description An organization ID. Only return organizations with an ID greater than this ID. */
- readonly since?: components["parameters"]["since-org"];
+ since?: components["parameters"]["since-org"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
/** @example ; rel="next" */
- readonly Link?: string;
- readonly [name: string]: unknown;
+ Link?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-simple"][];
+ "application/json": components["schemas"]["organization-simple"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ };
+ };
+ "actions/get-actions-cache-retention-limit-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-organization"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-actions-cache-retention-limit-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-organization"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 304: components["responses"]["not_modified"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "billing/get-github-billing-usage-report-org": {
- readonly parameters: {
- readonly query?: {
- /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2024`. Default value is the current year. */
- readonly year?: components["parameters"]["billing-usage-report-year"];
- /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. */
- readonly month?: components["parameters"]["billing-usage-report-month"];
- /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. */
- readonly day?: components["parameters"]["billing-usage-report-day"];
- /** @description If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. */
- readonly hour?: components["parameters"]["billing-usage-report-hour"];
+ "actions/get-actions-cache-storage-limit-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
};
- readonly header?: never;
- readonly path: {
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-actions-cache-storage-limit-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["billing_usage_report_org"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 500: components["responses"]["internal_error"];
- readonly 503: components["responses"]["service_unavailable"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-organization"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/repository-access-for-org": {
+ parameters: {
+ query?: {
+ /** @description The page number of results to fetch. */
+ page?: number;
+ /** @description Number of results per page. */
+ per_page?: number;
+ };
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-full"];
+ "application/json": components["schemas"]["dependabot-repository-access-details"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "dependabot/update-repository-access-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of repository IDs to add. */
+ repository_ids_to_add?: number[];
+ /** @description List of repository IDs to remove. */
+ repository_ids_to_remove?: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/delete": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/set-repository-access-default-level": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The default repository access level for Dependabot updates.
+ * @example internal
+ * @enum {string}
+ */
+ default_level: "public" | "internal";
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "billing/get-all-budgets-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["get_all_budgets"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ };
+ };
+ "billing/get-budget-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The ID corresponding to the budget. */
+ budget_id: components["parameters"]["budget"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["budget"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "billing/delete-budget-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The ID corresponding to the budget. */
+ budget_id: components["parameters"]["budget"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["delete-budget"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "billing/update-budget-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The ID corresponding to the budget. */
+ budget_id: components["parameters"]["budget"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The budget amount in whole dollars. For license-based products, this represents the number of licenses. */
+ budget_amount?: number;
+ /** @description Whether to prevent additional spending once the budget is exceeded */
+ prevent_further_usage?: boolean;
+ budget_alerting?: {
+ /** @description Whether alerts are enabled for this budget */
+ will_alert?: boolean;
+ /** @description Array of user login names who will receive alerts */
+ alert_recipients?: string[];
+ };
+ /**
+ * @description The scope of the budget
+ * @enum {string}
+ */
+ budget_scope?: "enterprise" | "organization" | "repository" | "cost_center";
+ /** @description The name of the entity to apply the budget to */
+ budget_entity_name?: string;
+ /**
+ * @description The type of pricing for the budget
+ * @enum {string}
+ */
+ budget_type?: "ProductPricing" | "SkuPricing";
+ /** @description A single product or SKU that will be covered in the budget */
+ budget_product_sku?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Budget updated successfully */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /** @example Budget successfully updated. */
+ message?: string;
+ budget?: {
+ /** @description ID of the budget. */
+ id?: string;
+ /**
+ * Format: float
+ * @description The budget amount in whole dollars. For license-based products, this represents the number of licenses.
+ */
+ budget_amount?: number;
+ /** @description Whether to prevent additional spending once the budget is exceeded */
+ prevent_further_usage?: boolean;
+ budget_alerting?: {
+ /** @description Whether alerts are enabled for this budget */
+ will_alert: boolean;
+ /** @description Array of user login names who will receive alerts */
+ alert_recipients: string[];
+ };
+ /**
+ * @description The scope of the budget
+ * @enum {string}
+ */
+ budget_scope?: "enterprise" | "organization" | "repository" | "cost_center";
+ /**
+ * @description The name of the entity to apply the budget to
+ * @default
+ */
+ budget_entity_name: string;
+ /**
+ * @description The type of pricing for the budget
+ * @enum {string}
+ */
+ budget_type?: "ProductPricing" | "SkuPricing";
+ /** @description A single product or SKU that will be covered in the budget */
+ budget_product_sku?: string;
+ };
+ };
+ };
+ };
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ /** @description Budget not found or feature not enabled */
+ 404: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 422: components["responses"]["validation_failed"];
+ /** @description Internal server error */
+ 500: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ };
+ };
+ "billing/get-github-billing-premium-request-usage-report-org": {
+ parameters: {
+ query?: {
+ /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */
+ year?: components["parameters"]["billing-usage-report-year"];
+ /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */
+ month?: components["parameters"]["billing-usage-report-month-default"];
+ /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */
+ day?: components["parameters"]["billing-usage-report-day"];
+ /** @description The user name to query usage for. The name is not case sensitive. */
+ user?: components["parameters"]["billing-usage-report-user"];
+ /** @description The model name to query usage for. The name is not case sensitive. */
+ model?: components["parameters"]["billing-usage-report-model"];
+ /** @description The product name to query usage for. The name is not case sensitive. */
+ product?: components["parameters"]["billing-usage-report-product"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["billing_premium_request_usage_report_org"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "billing/get-github-billing-usage-report-org": {
+ parameters: {
+ query?: {
+ /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */
+ year?: components["parameters"]["billing-usage-report-year"];
+ /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. If no year is specified the default `year` is used. */
+ month?: components["parameters"]["billing-usage-report-month"];
+ /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */
+ day?: components["parameters"]["billing-usage-report-day"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["billing_usage_report_org"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "billing/get-github-billing-usage-summary-report-org": {
+ parameters: {
+ query?: {
+ /** @description If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, `2025`. Default value is the current year. */
+ year?: components["parameters"]["billing-usage-report-year"];
+ /** @description If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. Default value is the current month. If no year is specified the default `year` is used. */
+ month?: components["parameters"]["billing-usage-report-month-default"];
+ /** @description If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. If no `year` or `month` is specified, the default `year` and `month` are used. */
+ day?: components["parameters"]["billing-usage-report-day"];
+ /** @description The repository name to query for usage in the format owner/repository. */
+ repository?: components["parameters"]["billing-usage-report-repository"];
+ /** @description The product name to query usage for. The name is not case sensitive. */
+ product?: components["parameters"]["billing-usage-report-product"];
+ /** @description The SKU to query for usage. */
+ sku?: components["parameters"]["billing-usage-report-sku"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["billing_usage_summary_report_org"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "orgs/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["organization-full"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/delete": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Billing email address. This address is not publicized. */
- readonly billing_email?: string;
+ billing_email?: string;
/** @description The company name. */
- readonly company?: string;
+ company?: string;
/** @description The publicly visible email address. */
- readonly email?: string;
+ email?: string;
/** @description The Twitter username of the company. */
- readonly twitter_username?: string;
+ twitter_username?: string;
/** @description The location. */
- readonly location?: string;
+ location?: string;
/** @description The shorthand name of the company. */
- readonly name?: string;
+ name?: string;
/** @description The description of the company. The maximum size is 160 characters. */
- readonly description?: string;
+ description?: string;
/** @description Whether an organization can use organization projects. */
- readonly has_organization_projects?: boolean;
+ has_organization_projects?: boolean;
/** @description Whether repositories that belong to the organization can use repository projects. */
- readonly has_repository_projects?: boolean;
+ has_repository_projects?: boolean;
/**
* @description Default permission level members have for organization repositories.
* @default read
* @enum {string}
*/
- readonly default_repository_permission?: "read" | "write" | "admin" | "none";
+ default_repository_permission?: "read" | "write" | "admin" | "none";
/**
* @description Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.
* @default true
*/
- readonly members_can_create_repositories?: boolean;
+ members_can_create_repositories?: boolean;
/** @description Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- readonly members_can_create_internal_repositories?: boolean;
+ members_can_create_internal_repositories?: boolean;
/** @description Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- readonly members_can_create_private_repositories?: boolean;
+ members_can_create_private_repositories?: boolean;
/** @description Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation. */
- readonly members_can_create_public_repositories?: boolean;
+ members_can_create_public_repositories?: boolean;
/**
* @description Specifies which types of repositories non-admin organization members can create. `private` is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
* **Note:** This parameter is closing down and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.
* @enum {string}
*/
- readonly members_allowed_repository_creation_type?: "all" | "private" | "none";
+ members_allowed_repository_creation_type?: "all" | "private" | "none";
/**
* @description Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
* @default true
*/
- readonly members_can_create_pages?: boolean;
+ members_can_create_pages?: boolean;
/**
* @description Whether organization members can create public GitHub Pages sites. Existing published sites will not be impacted.
* @default true
*/
- readonly members_can_create_public_pages?: boolean;
+ members_can_create_public_pages?: boolean;
/**
* @description Whether organization members can create private GitHub Pages sites. Existing published sites will not be impacted.
* @default true
*/
- readonly members_can_create_private_pages?: boolean;
+ members_can_create_private_pages?: boolean;
/**
* @description Whether organization members can fork private organization repositories.
* @default false
*/
- readonly members_can_fork_private_repositories?: boolean;
+ members_can_fork_private_repositories?: boolean;
/**
* @description Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
* @default false
*/
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
/** @example "http://github.blog" */
- readonly blog?: string;
+ blog?: string;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91160,7 +97430,7 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly advanced_security_enabled_for_new_repositories?: boolean;
+ advanced_security_enabled_for_new_repositories?: boolean;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91171,7 +97441,7 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly dependabot_alerts_enabled_for_new_repositories?: boolean;
+ dependabot_alerts_enabled_for_new_repositories?: boolean;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91182,7 +97452,7 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly dependabot_security_updates_enabled_for_new_repositories?: boolean;
+ dependabot_security_updates_enabled_for_new_repositories?: boolean;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91193,7 +97463,7 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly dependency_graph_enabled_for_new_repositories?: boolean;
+ dependency_graph_enabled_for_new_repositories?: boolean;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91204,7 +97474,7 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly secret_scanning_enabled_for_new_repositories?: boolean;
+ secret_scanning_enabled_for_new_repositories?: boolean;
/**
* @deprecated
* @description **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead.
@@ -91215,2340 +97485,3682 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.
*/
- readonly secret_scanning_push_protection_enabled_for_new_repositories?: boolean;
+ secret_scanning_push_protection_enabled_for_new_repositories?: boolean;
/** @description Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. */
- readonly secret_scanning_push_protection_custom_link_enabled?: boolean;
+ secret_scanning_push_protection_custom_link_enabled?: boolean;
/** @description If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. */
- readonly secret_scanning_push_protection_custom_link?: string;
+ secret_scanning_push_protection_custom_link?: string;
/** @description Controls whether or not deploy keys may be added and used for repositories in the organization. */
- readonly deploy_keys_enabled_for_repositories?: boolean;
+ deploy_keys_enabled_for_repositories?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-full"];
+ "application/json": components["schemas"]["organization-full"];
};
};
- readonly 409: components["responses"]["conflict"];
+ 409: components["responses"]["conflict"];
/** @description Validation failed */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"];
+ "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"];
};
};
};
};
- readonly "actions/get-actions-cache-usage-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-actions-cache-usage-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-cache-usage-org-enterprise"];
+ "application/json": components["schemas"]["actions-cache-usage-org-enterprise"];
};
};
};
};
- readonly "actions/get-actions-cache-usage-by-repo-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/get-actions-cache-usage-by-repo-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repository_cache_usages: readonly components["schemas"]["actions-cache-usage-by-repository"][];
+ "application/json": {
+ total_count: number;
+ repository_cache_usages: components["schemas"]["actions-cache-usage-by-repository"][];
};
};
};
};
};
- readonly "actions/list-hosted-runners-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-hosted-runners-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runners: readonly components["schemas"]["actions-hosted-runner"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["actions-hosted-runner"][];
};
};
};
};
};
- readonly "actions/create-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
- readonly name: string;
+ name: string;
/** @description The image of runner. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */
- readonly image: {
+ image: {
/** @description The unique identifier of the runner image. */
- readonly id?: string;
+ id?: string;
/**
* @description The source of the runner image.
* @enum {string}
*/
- readonly source?: "github" | "partner" | "custom";
+ source?: "github" | "partner" | "custom";
/** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */
- readonly version?: string | null;
+ version?: string | null;
};
/** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */
- readonly size: string;
+ size: string;
/** @description The existing runner group to add this runner to. */
- readonly runner_group_id: number;
+ runner_group_id: number;
/** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */
- readonly maximum_runners?: number;
+ maximum_runners?: number;
/** @description Whether this runner should be created with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */
- readonly enable_static_ip?: boolean;
+ enable_static_ip?: boolean;
+ /**
+ * @description Whether this runner should be used to generate custom images.
+ * @default false
+ */
+ image_gen?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-hosted-runner"];
+ "application/json": components["schemas"]["actions-hosted-runner"];
};
};
};
};
- readonly "actions/get-hosted-runners-github-owned-images-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/list-custom-images-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly images: readonly components["schemas"]["actions-hosted-runner-image"][];
+ "application/json": {
+ total_count: number;
+ images: components["schemas"]["actions-hosted-runner-custom-image"][];
};
};
};
};
};
- readonly "actions/get-hosted-runners-partner-images-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-custom-image-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description Image definition ID of custom image */
+ image_definition_id: components["parameters"]["actions-custom-image-definition-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-hosted-runner-custom-image"];
+ };
+ };
+ };
+ };
+ "actions/delete-custom-image-from-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description Image definition ID of custom image */
+ image_definition_id: components["parameters"]["actions-custom-image-definition-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "actions/list-custom-image-versions-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description Image definition ID of custom image */
+ image_definition_id: components["parameters"]["actions-custom-image-definition-id"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly images: readonly components["schemas"]["actions-hosted-runner-image"][];
+ "application/json": {
+ total_count: number;
+ image_versions: components["schemas"]["actions-hosted-runner-custom-image-version"][];
};
};
};
};
};
- readonly "actions/get-hosted-runners-limits-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-custom-image-version-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ /** @description Image definition ID of custom image */
+ image_definition_id: components["parameters"]["actions-custom-image-definition-id"];
+ /** @description Version of a custom image */
+ version: components["parameters"]["actions-custom-image-version"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-hosted-runner-limits"];
+ "application/json": components["schemas"]["actions-hosted-runner-custom-image-version"];
};
};
};
};
- readonly "actions/get-hosted-runners-machine-specs-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-custom-image-version-from-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ /** @description Image definition ID of custom image */
+ image_definition_id: components["parameters"]["actions-custom-image-definition-id"];
+ /** @description Version of a custom image */
+ version: components["parameters"]["actions-custom-image-version"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "actions/get-hosted-runners-github-owned-images-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly machine_specs: readonly components["schemas"]["actions-hosted-runner-machine-spec"][];
+ "application/json": {
+ total_count: number;
+ images: components["schemas"]["actions-hosted-runner-curated-image"][];
};
};
};
};
};
- readonly "actions/get-hosted-runners-platforms-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-hosted-runners-partner-images-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly platforms: readonly string[];
+ "application/json": {
+ total_count: number;
+ images: components["schemas"]["actions-hosted-runner-curated-image"][];
};
};
};
};
};
- readonly "actions/get-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-hosted-runners-limits-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-hosted-runner-limits"];
+ };
+ };
+ };
+ };
+ "actions/get-hosted-runners-machine-specs-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ machine_specs: components["schemas"]["actions-hosted-runner-machine-spec"][];
+ };
+ };
+ };
+ };
+ };
+ "actions/get-hosted-runners-platforms-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ total_count: number;
+ platforms: string[];
+ };
+ };
+ };
+ };
+ };
+ "actions/get-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
/** @description Unique identifier of the GitHub-hosted runner. */
- readonly hosted_runner_id: components["parameters"]["hosted-runner-id"];
+ hosted_runner_id: components["parameters"]["hosted-runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-hosted-runner"];
+ "application/json": components["schemas"]["actions-hosted-runner"];
};
};
};
};
- readonly "actions/delete-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the GitHub-hosted runner. */
- readonly hosted_runner_id: components["parameters"]["hosted-runner-id"];
+ hosted_runner_id: components["parameters"]["hosted-runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-hosted-runner"];
+ "application/json": components["schemas"]["actions-hosted-runner"];
};
};
};
};
- readonly "actions/update-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/update-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the GitHub-hosted runner. */
- readonly hosted_runner_id: components["parameters"]["hosted-runner-id"];
+ hosted_runner_id: components["parameters"]["hosted-runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Name of the runner. Must be between 1 and 64 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
- readonly name?: string;
+ name?: string;
/** @description The existing runner group to add this runner to. */
- readonly runner_group_id?: number;
+ runner_group_id?: number;
/** @description The maximum amount of runners to scale up to. Runners will not auto-scale above this number. Use this setting to limit your cost. */
- readonly maximum_runners?: number;
+ maximum_runners?: number;
/** @description Whether this runner should be updated with a static public IP. Note limit on account. To list limits on account, use `GET actions/hosted-runners/limits` */
- readonly enable_static_ip?: boolean;
+ enable_static_ip?: boolean;
+ /** @description The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes` */
+ size?: string;
+ /** @description The unique identifier of the runner image. To list all available images, use `GET /actions/hosted-runners/images/github-owned` or `GET /actions/hosted-runners/images/partner`. */
+ image_id?: string;
/** @description The version of the runner image to deploy. This is relevant only for runners using custom images. */
- readonly image_version?: string | null;
+ image_version?: string | null;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-hosted-runner"];
+ "application/json": components["schemas"]["actions-hosted-runner"];
};
};
};
};
- readonly "oidc/get-oidc-custom-sub-template-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "oidc/get-oidc-custom-sub-template-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description A JSON serialized template for OIDC subject claim customization */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["oidc-custom-sub"];
+ "application/json": components["schemas"]["oidc-custom-sub"];
};
};
};
};
- readonly "oidc/update-oidc-custom-sub-template-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "oidc/update-oidc-custom-sub-template-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["oidc-custom-sub"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["oidc-custom-sub"];
};
};
- readonly responses: {
+ responses: {
/** @description Empty response */
- readonly 201: {
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["empty-object"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/get-github-actions-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["actions-organization-permissions"];
+ };
+ };
+ };
+ };
+ "actions/set-github-actions-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ enabled_repositories: components["schemas"]["enabled-repositories"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
+ sha_pinning_required?: components["schemas"]["sha-pinning-required"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
};
};
- readonly "actions/get-github-actions-permissions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-artifact-and-log-retention-settings-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-organization-permissions"];
+ "application/json": components["schemas"]["actions-artifact-and-log-retention-response"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-github-actions-permissions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-artifact-and-log-retention-settings-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-artifact-and-log-retention"];
};
- readonly cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly enabled_repositories: components["schemas"]["enabled-repositories"];
- readonly allowed_actions?: components["schemas"]["allowed-actions"];
+ responses: {
+ /** @description No content */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
- readonly responses: {
+ };
+ "actions/get-fork-pr-contributor-approval-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-contributor-approval"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-fork-pr-contributor-approval-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-contributor-approval"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
content?: never;
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/get-private-repo-fork-pr-workflows-settings-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/list-selected-repositories-enabled-github-actions-organization": {
- readonly parameters: {
- readonly query?: {
+ "actions/set-private-repo-fork-pr-workflows-settings-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"];
+ };
+ };
+ responses: {
+ /** @description Empty response for successful settings update */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ /** @description Forbidden - Fork PR workflow settings for private repositories are managed by the enterprise owner */
+ 403: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/list-selected-repositories-enabled-github-actions-organization": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["repository"][];
};
};
};
};
};
- readonly "actions/set-selected-repositories-enabled-github-actions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-selected-repositories-enabled-github-actions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description List of repository IDs to enable for GitHub Actions. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/enable-selected-repository-github-actions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/enable-selected-repository-github-actions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/disable-selected-repository-github-actions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/disable-selected-repository-github-actions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/get-allowed-actions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-allowed-actions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["selected-actions"];
+ "application/json": components["schemas"]["selected-actions"];
};
};
};
};
- readonly "actions/set-allowed-actions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-allowed-actions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": components["schemas"]["selected-actions"];
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["selected-actions"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/get-github-actions-default-workflow-permissions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-self-hosted-runners-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
+ "application/json": components["schemas"]["self-hosted-runners-settings"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-self-hosted-runners-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The policy that controls whether self-hosted runners can be used in the organization
+ * @enum {string}
+ */
+ enabled_repositories: "all" | "selected" | "none";
+ };
+ };
+ };
+ responses: {
+ /** @description No content */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/list-selected-repositories-self-hosted-runners-organization": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ total_count?: number;
+ repositories?: components["schemas"]["repository"][];
+ };
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-selected-repositories-self-hosted-runners-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description IDs of repositories that can use repository-level self-hosted runners */
+ selected_repository_ids: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description No content */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/enable-selected-repository-self-hosted-runners-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the repository. */
+ repository_id: components["parameters"]["repository-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description No content */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "actions/set-github-actions-default-workflow-permissions-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/disable-selected-repository-self-hosted-runners-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the repository. */
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ requestBody?: never;
+ responses: {
+ /** @description No content */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/get-github-actions-default-workflow-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
+ };
+ };
+ };
+ };
+ "actions/set-github-actions-default-workflow-permissions-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
};
+ cookie?: never;
};
- readonly responses: {
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ };
+ };
+ responses: {
/** @description Success response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-self-hosted-runner-groups-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-self-hosted-runner-groups-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Only return runner groups that are allowed to be used by this repository. */
- readonly visible_to_repository?: components["parameters"]["visible-to-repository"];
+ visible_to_repository?: components["parameters"]["visible-to-repository"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runner_groups: readonly components["schemas"]["runner-groups-org"][];
+ "application/json": {
+ total_count: number;
+ runner_groups: components["schemas"]["runner-groups-org"][];
};
};
};
};
};
- readonly "actions/create-self-hosted-runner-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-self-hosted-runner-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Name of the runner group. */
- readonly name: string;
+ name: string;
/**
* @description Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.
* @default all
* @enum {string}
*/
- readonly visibility?: "selected" | "all" | "private";
+ visibility?: "selected" | "all" | "private";
/** @description List of repository IDs that can access the runner group. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
/** @description List of runner IDs to add to the runner group. */
- readonly runners?: readonly number[];
+ runners?: number[];
/**
* @description Whether the runner group can be used by `public` repositories.
* @default false
*/
- readonly allows_public_repositories?: boolean;
+ allows_public_repositories?: boolean;
/**
* @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
* @default false
*/
- readonly restricted_to_workflows?: boolean;
+ restricted_to_workflows?: boolean;
/** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */
- readonly selected_workflows?: readonly string[];
+ selected_workflows?: string[];
/** @description The identifier of a hosted compute network configuration. */
- readonly network_configuration_id?: string;
+ network_configuration_id?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["runner-groups-org"];
+ "application/json": components["schemas"]["runner-groups-org"];
};
};
};
};
- readonly "actions/get-self-hosted-runner-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-self-hosted-runner-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["runner-groups-org"];
+ "application/json": components["schemas"]["runner-groups-org"];
};
};
};
};
- readonly "actions/delete-self-hosted-runner-group-from-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-self-hosted-runner-group-from-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/update-self-hosted-runner-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/update-self-hosted-runner-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Name of the runner group. */
- readonly name: string;
+ name: string;
/**
* @description Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
* @enum {string}
*/
- readonly visibility?: "selected" | "all" | "private";
+ visibility?: "selected" | "all" | "private";
/**
* @description Whether the runner group can be used by `public` repositories.
* @default false
*/
- readonly allows_public_repositories?: boolean;
+ allows_public_repositories?: boolean;
/**
* @description If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
* @default false
*/
- readonly restricted_to_workflows?: boolean;
+ restricted_to_workflows?: boolean;
/** @description List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`. */
- readonly selected_workflows?: readonly string[];
+ selected_workflows?: string[];
/** @description The identifier of a hosted compute network configuration. */
- readonly network_configuration_id?: string | null;
+ network_configuration_id?: string | null;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["runner-groups-org"];
+ "application/json": components["schemas"]["runner-groups-org"];
};
};
};
};
- readonly "actions/list-github-hosted-runners-in-group-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-github-hosted-runners-in-group-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runners: readonly components["schemas"]["actions-hosted-runner"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["actions-hosted-runner"][];
};
};
};
};
};
- readonly "actions/list-repo-access-to-self-hosted-runner-group-in-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-access-to-self-hosted-runner-group-in-org": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["minimal-repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
};
};
- readonly "actions/set-repo-access-to-self-hosted-runner-group-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-repo-access-to-self-hosted-runner-group-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description List of repository IDs that can access the runner group. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/add-repo-access-to-self-hosted-runner-group-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-repo-access-to-self-hosted-runner-group-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
/** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/remove-repo-access-to-self-hosted-runner-group-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-repo-access-to-self-hosted-runner-group-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
/** @description The unique identifier of the repository. */
- readonly repository_id: components["parameters"]["repository-id"];
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-self-hosted-runners-in-group-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-self-hosted-runners-in-group-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runners: readonly components["schemas"]["runner"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["runner"][];
};
};
};
};
};
- readonly "actions/set-self-hosted-runners-in-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-self-hosted-runners-in-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description List of runner IDs to add to the runner group. */
- readonly runners: readonly number[];
+ runners: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/add-self-hosted-runner-to-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-self-hosted-runner-to-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/remove-self-hosted-runner-from-group-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-self-hosted-runner-from-group-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner group. */
- readonly runner_group_id: components["parameters"]["runner-group-id"];
+ runner_group_id: components["parameters"]["runner-group-id"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-self-hosted-runners-for-org": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-self-hosted-runners-for-org": {
+ parameters: {
+ query?: {
/** @description The name of a self-hosted runner. */
- readonly name?: string;
+ name?: string;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runners: readonly components["schemas"]["runner"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["runner"][];
};
};
};
};
};
- readonly "actions/list-runner-applications-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/list-runner-applications-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["runner-application"][];
+ "application/json": components["schemas"]["runner-application"][];
};
};
};
};
- readonly "actions/generate-runner-jitconfig-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/generate-runner-jitconfig-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the new runner. */
- readonly name: string;
+ name: string;
/** @description The ID of the runner group to register the runner to. */
- readonly runner_group_id: number;
+ runner_group_id: number;
/** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */
- readonly labels: readonly string[];
+ labels: string[];
/**
* @description The working directory to be used for job execution, relative to the runner install directory.
* @default _work
*/
- readonly work_folder?: string;
+ work_folder?: string;
};
};
};
- readonly responses: {
- readonly 201: components["responses"]["actions_runner_jitconfig"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 201: components["responses"]["actions_runner_jitconfig"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/create-registration-token-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-registration-token-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- readonly "actions/create-remove-token-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-remove-token-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- readonly "actions/get-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["runner"];
+ "application/json": components["schemas"]["runner"];
};
};
};
};
- readonly "actions/delete-self-hosted-runner-from-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-self-hosted-runner-from-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/list-labels-for-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/list-labels-for-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-custom-labels-for-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-custom-labels-for-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
- readonly labels: readonly string[];
+ labels: string[];
};
};
};
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/add-custom-labels-to-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-custom-labels-to-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of the custom labels to add to the runner. */
- readonly labels: readonly string[];
+ labels: string[];
};
};
};
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-all-custom-labels-from-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels_readonly"];
- readonly 404: components["responses"]["not_found"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels_readonly"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/remove-custom-label-from-self-hosted-runner-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-custom-label-from-self-hosted-runner-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
/** @description The name of a self-hosted runner's custom label. */
- readonly name: components["parameters"]["runner-label-name"];
+ name: components["parameters"]["runner-label-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/list-org-secrets": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-org-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["organization-actions-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["organization-actions-secret"][];
};
};
};
};
};
- readonly "actions/get-org-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-org-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-public-key"];
+ "application/json": components["schemas"]["actions-public-key"];
};
};
};
};
- readonly "actions/get-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-actions-secret"];
+ "application/json": components["schemas"]["organization-actions-secret"];
};
};
};
};
- readonly "actions/create-or-update-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-or-update-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/actions/secrets#get-an-organization-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id: string;
/**
* @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/delete-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-selected-repos-for-org-secret": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["minimal-repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
};
};
- readonly "actions/set-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-selected-repos-for-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/add-selected-repo-to-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-selected-repo-to-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description No Content when repository was added to the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Conflict when visibility type is not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/remove-selected-repo-from-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-selected-repo-from-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response when repository was removed from the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Conflict when visibility type not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-org-variables": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-org-variables": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["variables-per-page"];
+ per_page?: components["parameters"]["variables-per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly variables: readonly components["schemas"]["organization-actions-variable"][];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["organization-actions-variable"][];
};
};
};
};
};
- readonly "actions/create-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name: string;
+ name: string;
/** @description The value of the variable. */
- readonly value: string;
+ value: string;
/**
* @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a variable */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "actions/get-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-actions-variable"];
+ "application/json": components["schemas"]["organization-actions-variable"];
};
};
};
};
- readonly "actions/delete-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/update-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/update-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name?: string;
+ name?: string;
/** @description The value of the variable. */
- readonly value?: string;
+ value?: string;
/**
* @description The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
* @enum {string}
*/
- readonly visibility?: "all" | "private" | "selected";
+ visibility?: "all" | "private" | "selected";
/** @description An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-selected-repos-for-org-variable": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-selected-repos-for-org-variable": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["minimal-repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
/** @description Response when the visibility of the variable is not set to `selected` */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/set-selected-repos-for-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-selected-repos-for-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The IDs of the repositories that can access the organization variable. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response when the visibility of the variable is not set to `selected` */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/add-selected-repo-to-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-selected-repo-to-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
- readonly repository_id: number;
+ name: components["parameters"]["variable-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response when the visibility of the variable is not set to `selected` */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/remove-selected-repo-from-org-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-selected-repo-from-org-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
- readonly repository_id: number;
+ name: components["parameters"]["variable-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response when the visibility of the variable is not set to `selected` */
- readonly 409: {
+ 409: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "orgs/create-artifact-deployment-record": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The name of the artifact.
+ * @example libfoo
+ */
+ name: string;
+ /** @description The hex encoded digest of the artifact. */
+ digest: string;
+ /**
+ * @description The artifact version.
+ * @example 1.2.3
+ */
+ version?: string;
+ /**
+ * @description The status of the artifact. Can be either deployed or decommissioned.
+ * @enum {string}
+ */
+ status: "deployed" | "decommissioned";
+ /** @description The stage of the deployment. */
+ logical_environment: string;
+ /** @description The physical region of the deployment. */
+ physical_environment?: string;
+ /** @description The deployment cluster. */
+ cluster?: string;
+ /**
+ * @description The unique identifier for the deployment represented by the new record. To accommodate differing
+ * containers and namespaces within a cluster, the following format is recommended:
+ * {namespaceName}-{deploymentName}-{containerName}.
+ */
+ deployment_name: string;
+ /** @description The tags associated with the deployment. */
+ tags?: {
+ [key: string]: string;
+ };
+ /** @description A list of runtime risks associated with the deployment. */
+ runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[];
+ /**
+ * @description The name of the GitHub repository associated with the artifact. This should be used
+ * when there are no provenance attestations available for the artifact. The repository
+ * must belong to the organization specified in the path parameter.
+ *
+ * If a provenance attestation is available for the artifact, the API will use
+ * the repository information from the attestation instead of this parameter.
+ * @example my-github-repo
+ */
+ github_repository?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Artifact deployment record stored successfully. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /** @description The number of deployment records created */
+ total_count?: number;
+ deployment_records?: components["schemas"]["artifact-deployment-record"][];
+ };
+ };
+ };
+ };
+ };
+ "orgs/set-cluster-deployment-records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The cluster name. */
+ cluster: string;
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The stage of the deployment. */
+ logical_environment: string;
+ /** @description The physical region of the deployment. */
+ physical_environment?: string;
+ /** @description The list of deployments to record. */
+ deployments: {
+ /**
+ * @description The name of the artifact. Note that if multiple deployments have identical 'digest' parameter values,
+ * the name parameter must also be identical across all entries.
+ */
+ name: string;
+ /**
+ * @description The hex encoded digest of the artifact. Note that if multiple deployments have identical 'digest' parameter values,
+ * the name and version parameters must also be identical across all entries.
+ */
+ digest: string;
+ /**
+ * @description The artifact version. Note that if multiple deployments have identical 'digest' parameter values,
+ * the version parameter must also be identical across all entries.
+ * @example 1.2.3
+ */
+ version?: string;
+ /**
+ * @description The deployment status of the artifact.
+ * @enum {string}
+ */
+ status?: "deployed" | "decommissioned";
+ /**
+ * @description The unique identifier for the deployment represented by the new record. To accommodate differing
+ * containers and namespaces within a record set, the following format is recommended:
+ * {namespaceName}-{deploymentName}-{containerName}.
+ * The deployment_name must be unique across all entries in the deployments array.
+ */
+ deployment_name: string;
+ /**
+ * @description The name of the GitHub repository associated with the artifact. This should be used
+ * when there are no provenance attestations available for the artifact. The repository
+ * must belong to the organization specified in the path parameter.
+ *
+ * If a provenance attestation is available for the artifact, the API will use
+ * the repository information from the attestation instead of this parameter.
+ * @example my-github-repo
+ */
+ github_repository?: string;
+ /** @description Key-value pairs to tag the deployment record. */
+ tags?: {
+ [key: string]: string;
+ };
+ /** @description A list of runtime risks associated with the deployment. */
+ runtime_risks?: ("critical-resource" | "internet-exposed" | "lateral-movement" | "sensitive-data")[];
+ }[];
+ };
+ };
+ };
+ responses: {
+ /** @description Deployment records created or updated successfully. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /** @description The number of deployment records created */
+ total_count?: number;
+ deployment_records?: components["schemas"]["artifact-deployment-record"][];
+ };
+ };
+ };
+ };
+ };
+ "orgs/create-artifact-storage-record": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The name of the artifact.
+ * @example libfoo
+ */
+ name: string;
+ /**
+ * @description The digest of the artifact (algorithm:hex-encoded-digest).
+ * @example sha256:0ecbaa601dba202129058746c7d8e3f282d0efb5fff0...
+ */
+ digest: string;
+ /**
+ * @description The artifact version.
+ * @example 1.2.3
+ */
+ version?: string;
+ /**
+ * Format: uri
+ * @description The URL where the artifact is stored.
+ * @example https://reg.example.com/artifactory/bar/libfoo-1.2.3
+ */
+ artifact_url?: string;
+ /**
+ * Format: uri
+ * @description The path of the artifact.
+ * @example com/github/bar/libfoo-1.2.3
+ */
+ path?: string;
+ /**
+ * Format: uri
+ * @description The base URL of the artifact registry.
+ * @example https://reg.example.com/artifactory/
+ */
+ registry_url: string;
+ /**
+ * @description The repository name within the registry.
+ * @example bar
+ */
+ repository?: string;
+ /**
+ * @description The status of the artifact (e.g., active, inactive).
+ * @default active
+ * @example active
+ * @enum {string}
+ */
+ status?: "active" | "eol" | "deleted";
+ /**
+ * @description The name of the GitHub repository associated with the artifact. This should be used
+ * when there are no provenance attestations available for the artifact. The repository
+ * must belong to the organization specified in the path parameter.
+ *
+ * If a provenance attestation is available for the artifact, the API will use
+ * the repository information from the attestation instead of this parameter.
+ * @example my-github-repo
+ */
+ github_repository?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Artifact metadata storage record stored successfully. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /** @example 1 */
+ total_count?: number;
+ storage_records?: {
+ id?: number;
+ name?: string;
+ digest?: string;
+ artifact_url?: string | null;
+ registry_url?: string;
+ repository?: string | null;
+ status?: string;
+ created_at?: string;
+ updated_at?: string;
+ }[];
+ };
+ };
+ };
+ };
+ };
+ "orgs/list-artifact-deployment-records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The SHA256 digest of the artifact, in the form `sha256:HEX_DIGEST`. */
+ subject_digest: components["parameters"]["subject-digest"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Successful response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /**
+ * @description The number of deployment records for this digest and organization
+ * @example 3
+ */
+ total_count?: number;
+ deployment_records?: components["schemas"]["artifact-deployment-record"][];
+ };
+ };
+ };
+ };
+ };
+ "orgs/list-artifact-storage-records": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /**
+ * @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`.
+ * @example sha256:1bb1e949e55dcefc6353e7b36c8897d2a107d8e8dca49d4e3c0ea8493fc0bc72
+ */
+ subject_digest: string;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /**
+ * @description The number of storage records for this digest and organization
+ * @example 3
+ */
+ total_count?: number;
+ storage_records?: {
+ id?: number;
+ name?: string;
+ digest?: string;
+ artifact_url?: string;
+ registry_url?: string;
+ repository?: string;
+ status?: string;
+ created_at?: string;
+ updated_at?: string;
+ }[];
+ };
+ };
+ };
+ };
+ };
+ "orgs/list-attestations-bulk": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of subject digests to fetch attestations for. */
+ subject_digests: string[];
+ /**
+ * @description Optional filter for fetching attestations with a given predicate type.
+ * This option accepts `provenance`, `sbom`, `release`, or freeform text
+ * for custom predicate types.
+ */
+ predicate_type?: string;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ /** @description Mapping of subject digest to bundles. */
+ attestations_subject_digests?: {
+ [key: string]: {
+ /** @description The bundle of the attestation. */
+ bundle?: {
+ mediaType?: string;
+ verificationMaterial?: {
+ [key: string]: unknown;
+ };
+ dsseEnvelope?: {
+ [key: string]: unknown;
+ };
+ };
+ repository_id?: number;
+ bundle_url?: string;
+ }[] | null;
+ };
+ /** @description Information about the current page. */
+ page_info?: {
+ /** @description Indicates whether there is a next page. */
+ has_next?: boolean;
+ /** @description Indicates whether there is a previous page. */
+ has_previous?: boolean;
+ /** @description The cursor to the next page. */
+ next?: string;
+ /** @description The cursor to the previous page. */
+ previous?: string;
+ };
+ };
+ };
+ };
+ };
+ };
+ "orgs/delete-attestations-bulk": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description List of subject digests associated with the artifact attestations to delete. */
+ subject_digests: string[];
+ } | {
+ /** @description List of unique IDs associated with the artifact attestations to delete. */
+ attestation_ids: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
};
content?: never;
};
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-attestations": {
- readonly parameters: {
- readonly query?: {
+ "orgs/delete-attestations-by-subject-digest": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description Subject Digest */
+ subject_digest: string;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/list-attestation-repositories": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ /**
+ * @description Optional filter for fetching attestations with a given predicate type.
+ * This option accepts `provenance`, `sbom`, `release`, or freeform text
+ * for custom predicate types.
+ */
+ predicate_type?: string;
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": {
+ id?: number;
+ name?: string;
+ }[];
+ };
+ };
+ };
+ };
+ "orgs/delete-attestations-by-id": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description Attestation ID */
+ attestation_id: number;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/list-attestations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
+ /**
+ * @description Optional filter for fetching attestations with a given predicate type.
+ * This option accepts `provenance`, `sbom`, `release`, or freeform text
+ * for custom predicate types.
+ */
+ predicate_type?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */
- readonly subject_digest: string;
+ subject_digest: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly attestations?: readonly {
+ "application/json": {
+ attestations?: {
/**
* @description The attestation's Sigstore Bundle.
* Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
*/
- readonly bundle?: {
- readonly mediaType?: string;
- readonly verificationMaterial?: {
- readonly [key: string]: unknown;
+ bundle?: {
+ mediaType?: string;
+ verificationMaterial?: {
+ [key: string]: unknown;
};
- readonly dsseEnvelope?: {
- readonly [key: string]: unknown;
+ dsseEnvelope?: {
+ [key: string]: unknown;
};
- };
- readonly repository_id?: number;
- readonly bundle_url?: string;
+ } | null;
+ repository_id?: number;
+ bundle_url?: string;
+ initiator?: string;
}[];
};
};
};
};
};
- readonly "orgs/list-blocked-users": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-blocked-users": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
- readonly "orgs/check-blocked-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/check-blocked-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description If the user is blocked */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description If the user is not blocked */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "orgs/block-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/block-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/unblock-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/unblock-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "code-scanning/list-alerts-for-org": {
- readonly parameters: {
- readonly query?: {
+ "campaigns/list-org-campaigns": {
+ parameters: {
+ query?: {
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description The direction to sort the results by. */
+ direction?: components["parameters"]["direction"];
+ /** @description If specified, only campaigns with this state will be returned. */
+ state?: components["schemas"]["campaign-state"];
+ /** @description The property by which to sort the results. */
+ sort?: "created" | "updated" | "ends_at" | "published";
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["campaign-summary"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "campaigns/create-campaign": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the campaign */
+ name: string;
+ /** @description A description for the campaign */
+ description: string;
+ /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */
+ managers?: string[];
+ /** @description The slugs of the teams to set as the campaign managers. */
+ team_managers?: string[];
+ /**
+ * Format: date-time
+ * @description The end date and time of the campaign. The date must be in the future.
+ */
+ ends_at: string;
+ /**
+ * Format: uri
+ * @description The contact link of the campaign. Must be a URI.
+ */
+ contact_link?: string | null;
+ /** @description The code scanning alerts to include in this campaign */
+ code_scanning_alerts?: {
+ /** @description The repository id */
+ repository_id: number;
+ /** @description The alert numbers */
+ alert_numbers: number[];
+ }[] | null;
+ /**
+ * @description If true, will automatically generate issues for the campaign. The default is false.
+ * @default false
+ */
+ generate_issues?: boolean;
+ } & (unknown | unknown);
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["campaign-summary"];
+ };
+ };
+ /** @description Bad Request */
+ 400: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ /** @description Unprocessable Entity */
+ 422: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ /** @description Too Many Requests */
+ 429: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "campaigns/get-campaign-summary": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The campaign number. */
+ campaign_number: number;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["campaign-summary"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ /** @description Unprocessable Entity */
+ 422: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "campaigns/delete-campaign": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The campaign number. */
+ campaign_number: number;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Deletion successful */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "campaigns/update-campaign": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The campaign number. */
+ campaign_number: number;
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the campaign */
+ name?: string;
+ /** @description A description for the campaign */
+ description?: string;
+ /** @description The logins of the users to set as the campaign managers. At this time, only a single manager can be supplied. */
+ managers?: string[];
+ /** @description The slugs of the teams to set as the campaign managers. */
+ team_managers?: string[];
+ /**
+ * Format: date-time
+ * @description The end date and time of the campaign, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
+ */
+ ends_at?: string;
+ /**
+ * Format: uri
+ * @description The contact link of the campaign. Must be a URI.
+ */
+ contact_link?: string | null;
+ state?: components["schemas"]["campaign-state"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["campaign-summary"];
+ };
+ };
+ /** @description Bad Request */
+ 400: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ /** @description Unprocessable Entity */
+ 422: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "code-scanning/list-alerts-for-org": {
+ parameters: {
+ query?: {
/** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- readonly tool_name?: components["parameters"]["tool-name"];
+ tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- readonly tool_guid?: components["parameters"]["tool-guid"];
+ tool_guid?: components["parameters"]["tool-guid"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description If specified, only code scanning alerts with this state will be returned. */
- readonly state?: components["schemas"]["code-scanning-alert-state-query"];
+ state?: components["schemas"]["code-scanning-alert-state-query"];
/** @description The property by which to sort the results. */
- readonly sort?: "created" | "updated";
+ sort?: "created" | "updated";
/** @description If specified, only code scanning alerts with this severity will be returned. */
- readonly severity?: components["schemas"]["code-scanning-alert-severity"];
+ severity?: components["schemas"]["code-scanning-alert-severity"];
+ /**
+ * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ assignees?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-scanning-organization-alert-items"][];
+ "application/json": components["schemas"]["code-scanning-organization-alert-items"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-security/get-configurations-for-org": {
- readonly parameters: {
- readonly query?: {
+ "code-security/get-configurations-for-org": {
+ parameters: {
+ query?: {
/** @description The target type of the code security configuration */
- readonly target_type?: "global" | "all";
+ target_type?: "global" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-security-configuration"][];
+ "application/json": components["schemas"]["code-security-configuration"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/create-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/create-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the code security configuration. Must be unique within the organization. */
- readonly name: string;
+ name: string;
/** @description A description of the code security configuration */
- readonly description: string;
+ description: string;
/**
- * @description The enablement status of GitHub Advanced Security
+ * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
+ *
+ * > [!WARNING]
+ * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.
* @default disabled
* @enum {string}
*/
- readonly advanced_security?: "enabled" | "disabled";
+ advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection";
+ /**
+ * @description The enablement status of GitHub Code Security features.
+ * @enum {string}
+ */
+ code_security?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependency Graph
* @default enabled
* @enum {string}
*/
- readonly dependency_graph?: "enabled" | "disabled" | "not_set";
+ dependency_graph?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Automatic dependency submission
* @default disabled
* @enum {string}
*/
- readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
/** @description Feature options for Automatic dependency submission */
- readonly dependency_graph_autosubmit_action_options?: {
+ dependency_graph_autosubmit_action_options?: {
/**
* @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners.
* @default false
*/
- readonly labeled_runners?: boolean;
+ labeled_runners?: boolean;
};
/**
* @description The enablement status of Dependabot alerts
* @default disabled
* @enum {string}
*/
- readonly dependabot_alerts?: "enabled" | "disabled" | "not_set";
+ dependabot_alerts?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependabot security updates
* @default disabled
* @enum {string}
*/
- readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.
+ * @default disabled
+ * @enum {string}
+ */
+ dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ code_scanning_options?: components["schemas"]["code-scanning-options"];
/**
* @description The enablement status of code scanning default setup
* @default disabled
* @enum {string}
*/
- readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
- readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
+ code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ /**
+ * @description The enablement status of code scanning delegated alert dismissal
+ * @default not_set
+ * @enum {string}
+ */
+ code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of GitHub Secret Protection features.
+ * @enum {string}
+ */
+ secret_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning
* @default disabled
* @enum {string}
*/
- readonly secret_scanning?: "enabled" | "disabled" | "not_set";
+ secret_scanning?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning push protection
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
+ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning delegated bypass
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set";
+ secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set";
/** @description Feature options for secret scanning delegated bypass */
- readonly secret_scanning_delegated_bypass_options?: {
+ secret_scanning_delegated_bypass_options?: {
/** @description The bypass reviewers for secret scanning delegated bypass */
- readonly reviewers?: readonly {
+ reviewers?: {
/** @description The ID of the team or role selected as a bypass reviewer */
- readonly reviewer_id: number;
+ reviewer_id: number;
/**
* @description The type of the bypass reviewer
* @enum {string}
*/
- readonly reviewer_type: "TEAM" | "ROLE";
+ reviewer_type: "TEAM" | "ROLE";
}[];
};
/**
@@ -93556,1168 +101168,1257 @@ export interface operations {
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
+ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning non provider patterns
* @default disabled
* @enum {string}
*/
- readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Copilot secret scanning
+ * @default disabled
+ * @enum {string}
+ */
+ secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning delegated alert dismissal
+ * @enum {string}
+ */
+ secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning extended metadata
+ * @enum {string}
+ */
+ secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of private vulnerability reporting
* @default disabled
* @enum {string}
*/
- readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
+ private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
/**
* @description The enforcement status for a security configuration
* @default enforced
* @enum {string}
*/
- readonly enforcement?: "enforced" | "unenforced";
+ enforcement?: "enforced" | "unenforced";
};
};
};
- readonly responses: {
+ responses: {
/** @description Successfully created code security configuration */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
};
};
- readonly "code-security/get-default-configurations": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/get-default-configurations": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-default-configurations"];
+ "application/json": components["schemas"]["code-security-default-configurations"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/detach-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/detach-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description An array of repository IDs to detach from configurations. */
- readonly selected_repository_ids?: readonly number[];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An array of repository IDs to detach from configurations. Up to 250 IDs can be provided. */
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ responses: {
+ 204: components["responses"]["no_content"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "code-security/get-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/get-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/delete-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/delete-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ requestBody?: never;
+ responses: {
+ 204: components["responses"]["no_content"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "code-security/update-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/update-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the code security configuration. Must be unique within the organization. */
- readonly name?: string;
+ name?: string;
/** @description A description of the code security configuration */
- readonly description?: string;
+ description?: string;
/**
- * @description The enablement status of GitHub Advanced Security
+ * @description The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.
+ *
+ * > [!WARNING]
+ * > `code_security` and `secret_protection` are deprecated values for this field. Prefer the individual `code_security` and `secret_protection` fields to set the status of these features.
+ * @enum {string}
+ */
+ advanced_security?: "enabled" | "disabled" | "code_security" | "secret_protection";
+ /**
+ * @description The enablement status of GitHub Code Security features.
* @enum {string}
*/
- readonly advanced_security?: "enabled" | "disabled";
+ code_security?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependency Graph
* @enum {string}
*/
- readonly dependency_graph?: "enabled" | "disabled" | "not_set";
+ dependency_graph?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Automatic dependency submission
* @enum {string}
*/
- readonly dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
+ dependency_graph_autosubmit_action?: "enabled" | "disabled" | "not_set";
/** @description Feature options for Automatic dependency submission */
- readonly dependency_graph_autosubmit_action_options?: {
+ dependency_graph_autosubmit_action_options?: {
/** @description Whether to use runners labeled with 'dependency-submission' or standard GitHub runners. */
- readonly labeled_runners?: boolean;
+ labeled_runners?: boolean;
};
/**
* @description The enablement status of Dependabot alerts
* @enum {string}
*/
- readonly dependabot_alerts?: "enabled" | "disabled" | "not_set";
+ dependabot_alerts?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of Dependabot security updates
* @enum {string}
*/
- readonly dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ dependabot_security_updates?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Dependabot delegated alert dismissal. Requires Dependabot alerts to be enabled.
+ * @enum {string}
+ */
+ dependabot_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of code scanning default setup
* @enum {string}
*/
- readonly code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
- readonly code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_default_setup?: "enabled" | "disabled" | "not_set";
+ code_scanning_default_setup_options?: components["schemas"]["code-scanning-default-setup-options"];
+ code_scanning_options?: components["schemas"]["code-scanning-options"];
+ /**
+ * @description The enablement status of code scanning delegated alert dismissal
+ * @default disabled
+ * @enum {string}
+ */
+ code_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of GitHub Secret Protection features.
+ * @enum {string}
+ */
+ secret_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning
* @enum {string}
*/
- readonly secret_scanning?: "enabled" | "disabled" | "not_set";
+ secret_scanning?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning push protection
* @enum {string}
*/
- readonly secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
+ secret_scanning_push_protection?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning delegated bypass
* @enum {string}
*/
- readonly secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set";
+ secret_scanning_delegated_bypass?: "enabled" | "disabled" | "not_set";
/** @description Feature options for secret scanning delegated bypass */
- readonly secret_scanning_delegated_bypass_options?: {
+ secret_scanning_delegated_bypass_options?: {
/** @description The bypass reviewers for secret scanning delegated bypass */
- readonly reviewers?: readonly {
+ reviewers?: {
/** @description The ID of the team or role selected as a bypass reviewer */
- readonly reviewer_id: number;
+ reviewer_id: number;
/**
* @description The type of the bypass reviewer
* @enum {string}
*/
- readonly reviewer_type: "TEAM" | "ROLE";
+ reviewer_type: "TEAM" | "ROLE";
}[];
};
/**
* @description The enablement status of secret scanning validity checks
* @enum {string}
*/
- readonly secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
+ secret_scanning_validity_checks?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of secret scanning non-provider patterns
* @enum {string}
*/
- readonly secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ secret_scanning_non_provider_patterns?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of Copilot secret scanning
+ * @enum {string}
+ */
+ secret_scanning_generic_secrets?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning delegated alert dismissal
+ * @enum {string}
+ */
+ secret_scanning_delegated_alert_dismissal?: "enabled" | "disabled" | "not_set";
+ /**
+ * @description The enablement status of secret scanning extended metadata
+ * @enum {string}
+ */
+ secret_scanning_extended_metadata?: "enabled" | "disabled" | "not_set";
/**
* @description The enablement status of private vulnerability reporting
* @enum {string}
*/
- readonly private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
+ private_vulnerability_reporting?: "enabled" | "disabled" | "not_set";
/**
* @description The enforcement status for a security configuration
* @enum {string}
*/
- readonly enforcement?: "enforced" | "unenforced";
+ enforcement?: "enforced" | "unenforced";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when a configuration is updated */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration"];
+ "application/json": components["schemas"]["code-security-configuration"];
};
};
/** @description Response when no new updates are made */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "code-security/attach-configuration": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/attach-configuration": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The type of repositories to attach the configuration to. `selected` means the configuration will be attached to only the repositories specified by `selected_repository_ids`
* @enum {string}
*/
- readonly scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected";
+ scope: "all" | "all_without_configurations" | "public" | "private_or_internal" | "selected";
/** @description An array of repository IDs to attach the configuration to. You can only provide a list of repository ids when the `scope` is set to `selected`. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
+ responses: {
+ 202: components["responses"]["accepted"];
};
};
- readonly "code-security/set-configuration-as-default": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/set-configuration-as-default": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Specify which types of repository this security configuration should be applied to by default.
* @enum {string}
*/
- readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
+ default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
};
};
};
- readonly responses: {
+ responses: {
/** @description Default successfully changed. */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description Specifies which types of repository this security configuration is applied to by default.
* @enum {string}
*/
- readonly default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
- readonly configuration?: components["schemas"]["code-security-configuration"];
+ default_for_new_repos?: "all" | "none" | "private_and_internal" | "public";
+ configuration?: components["schemas"]["code-security-configuration"];
};
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "code-security/get-repositories-for-configuration": {
- readonly parameters: {
- readonly query?: {
+ "code-security/get-repositories-for-configuration": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/**
* @description A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned.
*
* Can be: `all`, `attached`, `attaching`, `detached`, `removed`, `enforced`, `failed`, `updating`, `removed_by_enterprise`
*/
- readonly status?: string;
+ status?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the code security configuration. */
- readonly configuration_id: components["parameters"]["configuration-id"];
+ configuration_id: components["parameters"]["configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-security-configuration-repositories"][];
+ "application/json": components["schemas"]["code-security-configuration-repositories"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "codespaces/list-in-organization": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-in-organization": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly codespaces: readonly components["schemas"]["codespace"][];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
};
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/set-codespaces-access": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/set-codespaces-access": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization.
* @enum {string}
*/
- readonly visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators";
+ visibility: "disabled" | "selected_members" | "all_members" | "all_members_and_outside_collaborators";
/** @description The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value. */
- readonly selected_usernames?: readonly string[];
+ selected_usernames?: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when successfully modifying permissions. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
/** @description Users are neither members nor collaborators of this organization. */
- readonly 400: {
+ 400: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/set-codespaces-access-users": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/set-codespaces-access-users": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The usernames of the organization members whose codespaces be billed to the organization. */
- readonly selected_usernames: readonly string[];
+ selected_usernames: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when successfully modifying permissions. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
/** @description Users are neither members nor collaborators of this organization. */
- readonly 400: {
+ 400: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/delete-codespaces-access-users": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/delete-codespaces-access-users": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The usernames of the organization members whose codespaces should not be billed to the organization. */
- readonly selected_usernames: readonly string[];
+ selected_usernames: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when successfully modifying permissions. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 304: components["responses"]["not_modified"];
+ 304: components["responses"]["not_modified"];
/** @description Users are neither members nor collaborators of this organization. */
- readonly 400: {
+ 400: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/list-org-secrets": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-org-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["codespaces-org-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["codespaces-org-secret"][];
};
};
};
};
};
- readonly "codespaces/get-org-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/get-org-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespaces-public-key"];
+ "application/json": components["schemas"]["codespaces-public-key"];
};
};
};
};
- readonly "codespaces/get-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/get-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespaces-org-secret"];
+ "application/json": components["schemas"]["codespaces-org-secret"];
};
};
};
};
- readonly "codespaces/create-or-update-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/create-or-update-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value?: string;
/** @description The ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id?: string;
/**
* @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/** @description An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "codespaces/delete-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/delete-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "codespaces/list-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-selected-repos-for-org-secret": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["minimal-repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "codespaces/set-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/set-selected-repos-for-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Conflict when visibility type not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "codespaces/add-selected-repo-to-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/add-selected-repo-to-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description No Content when repository was added to the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Conflict when visibility type is not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "codespaces/remove-selected-repo-from-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/remove-selected-repo-from-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response when repository was removed from the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Conflict when visibility type not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "copilot/get-copilot-organization-details": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/get-copilot-organization-details": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description OK */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["copilot-organization-details"];
+ "application/json": components["schemas"]["copilot-organization-details"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description There is a problem with your account's associated payment method. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/list-copilot-seats": {
- readonly parameters: {
- readonly query?: {
+ "copilot/list-copilot-seats": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/** @description Total number of Copilot seats for the organization currently being billed. */
- readonly total_seats?: number;
- readonly seats?: readonly components["schemas"]["copilot-seat-details"][];
+ total_seats?: number;
+ seats?: components["schemas"]["copilot-seat-details"][];
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/add-copilot-seats-for-teams": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/add-copilot-seats-for-teams": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description List of team names within the organization to which to grant access to GitHub Copilot. */
- readonly selected_teams: readonly string[];
+ selected_teams: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description OK */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly seats_created: number;
+ "application/json": {
+ seats_created: number;
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/cancel-copilot-seat-assignment-for-teams": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/cancel-copilot-seat-assignment-for-teams": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of teams from which to revoke access to GitHub Copilot. */
- readonly selected_teams: readonly string[];
+ selected_teams: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description OK */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly seats_cancelled: number;
+ "application/json": {
+ seats_cancelled: number;
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/add-copilot-seats-for-users": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/add-copilot-seats-for-users": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The usernames of the organization members to be granted access to GitHub Copilot. */
- readonly selected_usernames: readonly string[];
+ selected_usernames: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description OK */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly seats_created: number;
+ "application/json": {
+ seats_created: number;
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/cancel-copilot-seat-assignment-for-users": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/cancel-copilot-seat-assignment-for-users": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The usernames of the organization members for which to revoke access to GitHub Copilot. */
- readonly selected_usernames: readonly string[];
+ selected_usernames: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description OK */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly seats_cancelled: number;
+ "application/json": {
+ seats_cancelled: number;
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/copilot-metrics-for-organization": {
- readonly parameters: {
- readonly query?: {
- /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
- readonly since?: string;
- /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
- readonly until?: string;
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ "copilot/copilot-content-exclusion-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
};
- readonly header?: never;
- readonly path: {
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description OK */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["copilot-organization-content-exclusion-details"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ };
+ };
+ "copilot/set-copilot-content-exclusion-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ /** @description The content exclusion rules to set */
+ requestBody: {
+ content: {
+ "application/json": {
+ [key: string]: (string | {
+ ifAnyMatch: string[];
+ } | {
+ ifNoneMatch: string[];
+ })[];
+ };
+ };
+ };
+ responses: {
+ /** @description Success */
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][];
+ "application/json": {
+ message?: string;
+ };
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["usage_metrics_api_disabled"];
- readonly 500: components["responses"]["internal_error"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 413: components["responses"]["too_large"];
+ 422: components["responses"]["validation_failed_simple"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/usage-metrics-for-org": {
- readonly parameters: {
- readonly query?: {
- /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
- readonly since?: string;
+ "copilot/copilot-metrics-for-organization": {
+ parameters: {
+ query?: {
+ /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. */
+ since?: string;
/** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
- readonly until?: string;
+ until?: string;
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ page?: components["parameters"]["page"];
+ /** @description The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][];
+ "application/json": components["schemas"]["copilot-usage-metrics-day"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["usage_metrics_api_disabled"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "dependabot/list-alerts-for-org": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-alerts-for-org": {
+ parameters: {
+ query?: {
/**
* @description A comma-separated list of states. If specified, only alerts with these states will be returned.
*
* Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
*/
- readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
/**
* @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
*
* Can be: `low`, `medium`, `high`, `critical`
*/
- readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
/**
* @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
*
* Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
*/
- readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
/** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
/**
* @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
* - An exact number (`n`)
@@ -94726,476 +102427,489 @@ export interface operations {
*
* Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
*/
- readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ /** @description A comma-separated list of artifact registry URLs. If specified, only alerts for repositories with storage records matching these URLs will be returned. */
+ artifact_registry_url?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry-urls"];
+ /**
+ * @description A comma-separated list of Artifact Registry name strings. If specified, only alerts for repositories with storage records matching these registries will be returned.
+ *
+ * Can be: `jfrog-artifactory`
+ */
+ artifact_registry?: components["parameters"]["dependabot-alert-comma-separated-artifact-registry"];
+ /**
+ * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
+ * Multiple `has` filters can be passed to filter for alerts that have all of the values.
+ */
+ has?: components["parameters"]["dependabot-alert-org-scope-comma-separated-has"];
+ /**
+ * @description Filter alerts by assignees.
+ * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"];
+ /**
+ * @description A comma-separated list of runtime risk strings. If specified, only alerts for repositories with deployment records matching these risks will be returned.
+ *
+ * Can be: `critical-resource`, `internet-exposed`, `sensitive-data`, `lateral-movement`
+ */
+ runtime_risk?: components["parameters"]["dependabot-alert-comma-separated-runtime-risk"];
/** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */
- readonly scope?: components["parameters"]["dependabot-alert-scope"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
/**
* @description The property by which to sort the results.
* `created` means when the alert was created.
* `updated` means when the alert's state last changed.
* `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.
*/
- readonly sort?: components["parameters"]["dependabot-alert-sort"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
- * This parameter must not be used in combination with `last`.
- * Instead, use `per_page` in combination with `after` to fetch the first page of results.
- */
- readonly first?: components["parameters"]["pagination-first"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result.
- * This parameter must not be used in combination with `first`.
- * Instead, use `per_page` in combination with `before` to fetch the last page of results.
- */
- readonly last?: components["parameters"]["pagination-last"];
+ after?: components["parameters"]["pagination-after"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["dependabot-alert-with-repository"][];
+ "application/json": components["schemas"]["dependabot-alert-with-repository"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "dependabot/list-org-secrets": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-org-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["organization-dependabot-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["organization-dependabot-secret"][];
};
};
};
};
};
- readonly "dependabot/get-org-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/get-org-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependabot-public-key"];
+ "application/json": components["schemas"]["dependabot-public-key"];
};
};
};
};
- readonly "dependabot/get-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/get-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-dependabot-secret"];
+ "application/json": components["schemas"]["organization-dependabot-secret"];
};
};
};
};
- readonly "dependabot/create-or-update-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/create-or-update-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value?: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id?: string;
/**
* @description Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids?: readonly string[];
+ selected_repository_ids?: (number | string)[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependabot/delete-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/delete-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependabot/list-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-selected-repos-for-org-secret": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly repositories: readonly components["schemas"]["minimal-repository"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
};
};
};
};
};
- readonly "dependabot/set-selected-repos-for-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/set-selected-repos-for-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints. */
- readonly selected_repository_ids: readonly number[];
+ selected_repository_ids: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependabot/add-selected-repo-to-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/add-selected-repo-to-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description No Content when repository was added to the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Conflict when visibility type is not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependabot/remove-selected-repo-from-org-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/remove-selected-repo-from-org-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
- readonly repository_id: number;
+ secret_name: components["parameters"]["secret-name"];
+ repository_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response when repository was removed from the selected list */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Conflict when visibility type not set to selected */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "packages/list-docker-migration-conflicting-packages-for-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/list-docker-migration-conflicting-packages-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["package"][];
+ "application/json": components["schemas"]["package"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "activity/list-public-org-events": {
- readonly parameters: {
- readonly query?: {
+ "activity/list-public-org-events": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["event"][];
+ "application/json": components["schemas"]["event"][];
};
};
};
};
- readonly "orgs/list-failed-invitations": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-failed-invitations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-invitation"][];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-webhooks": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-webhooks": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["org-hook"][];
+ "application/json": components["schemas"]["org-hook"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/create-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/create-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Must be passed as "web". */
- readonly name: string;
+ name: string;
/** @description Key/value pairs to provide settings for this webhook. */
- readonly config: {
- readonly url: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ config: {
+ url: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
/** @example "kdaigle" */
- readonly username?: string;
+ username?: string;
/** @example "password" */
- readonly password?: string;
+ password?: string;
};
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. Set to `["*"]` to receive all possible events.
@@ -95203,102 +102917,102 @@ export interface operations {
* "push"
* ]
*/
- readonly events?: readonly string[];
+ events?: string[];
/**
* @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
* @default true
*/
- readonly active?: boolean;
+ active?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/orgs/octocat/hooks/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["org-hook"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/get-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["org-hook"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/delete-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/delete-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/update-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/update-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Key/value pairs to provide settings for this webhook. */
- readonly config?: {
- readonly url: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ config?: {
+ url: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
};
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
@@ -95306,678 +103020,678 @@ export interface operations {
* "push"
* ]
*/
- readonly events?: readonly string[];
+ events?: string[];
/**
* @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
* @default true
*/
- readonly active?: boolean;
+ active?: boolean;
/** @example "web" */
- readonly name?: string;
+ name?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-hook"];
+ "application/json": components["schemas"]["org-hook"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/get-webhook-config-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-webhook-config-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "orgs/update-webhook-config-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/update-webhook-config-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "orgs/list-webhook-deliveries": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-webhook-deliveries": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- readonly cursor?: components["parameters"]["cursor"];
+ cursor?: components["parameters"]["cursor"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["hook-delivery-item"][];
+ "application/json": components["schemas"]["hook-delivery-item"][];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/get-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
- readonly delivery_id: components["parameters"]["delivery-id"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook-delivery"];
+ "application/json": components["schemas"]["hook-delivery"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/redeliver-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/redeliver-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
- readonly delivery_id: components["parameters"]["delivery-id"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ requestBody?: never;
+ responses: {
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/ping-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/ping-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "api-insights/get-route-stats-by-actor": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-route-stats-by-actor": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["api-insights-route-stats-sort"];
+ sort?: components["parameters"]["api-insights-route-stats-sort"];
/** @description Providing a substring will filter results where the API route contains the substring. This is a case-insensitive search. */
- readonly api_route_substring?: components["parameters"]["api-insights-api-route-substring"];
+ api_route_substring?: components["parameters"]["api-insights-api-route-substring"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The type of the actor */
- readonly actor_type: components["parameters"]["api-insights-actor-type"];
+ actor_type: components["parameters"]["api-insights-actor-type"];
/** @description The ID of the actor */
- readonly actor_id: components["parameters"]["api-insights-actor-id"];
+ actor_id: components["parameters"]["api-insights-actor-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-route-stats"];
+ "application/json": components["schemas"]["api-insights-route-stats"];
};
};
};
};
- readonly "api-insights/get-subject-stats": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-subject-stats": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["api-insights-sort"];
+ sort?: components["parameters"]["api-insights-sort"];
/** @description Providing a substring will filter results where the subject name contains the substring. This is a case-insensitive search. */
- readonly subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"];
+ subject_name_substring?: components["parameters"]["api-insights-subject-name-substring"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-subject-stats"];
+ "application/json": components["schemas"]["api-insights-subject-stats"];
};
};
};
};
- readonly "api-insights/get-summary-stats": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-summary-stats": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-summary-stats"];
+ "application/json": components["schemas"]["api-insights-summary-stats"];
};
};
};
};
- readonly "api-insights/get-summary-stats-by-user": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-summary-stats-by-user": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the user to query for stats */
- readonly user_id: components["parameters"]["api-insights-user-id"];
+ user_id: components["parameters"]["api-insights-user-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-summary-stats"];
+ "application/json": components["schemas"]["api-insights-summary-stats"];
};
};
};
};
- readonly "api-insights/get-summary-stats-by-actor": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-summary-stats-by-actor": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The type of the actor */
- readonly actor_type: components["parameters"]["api-insights-actor-type"];
+ actor_type: components["parameters"]["api-insights-actor-type"];
/** @description The ID of the actor */
- readonly actor_id: components["parameters"]["api-insights-actor-id"];
+ actor_id: components["parameters"]["api-insights-actor-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-summary-stats"];
+ "application/json": components["schemas"]["api-insights-summary-stats"];
};
};
};
};
- readonly "api-insights/get-time-stats": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-time-stats": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */
- readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
+ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-time-stats"];
+ "application/json": components["schemas"]["api-insights-time-stats"];
};
};
};
};
- readonly "api-insights/get-time-stats-by-user": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-time-stats-by-user": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */
- readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
+ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the user to query for stats */
- readonly user_id: components["parameters"]["api-insights-user-id"];
+ user_id: components["parameters"]["api-insights-user-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-time-stats"];
+ "application/json": components["schemas"]["api-insights-time-stats"];
};
};
};
};
- readonly "api-insights/get-time-stats-by-actor": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-time-stats-by-actor": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) */
- readonly timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
+ timestamp_increment: components["parameters"]["api-insights-timestamp-increment"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The type of the actor */
- readonly actor_type: components["parameters"]["api-insights-actor-type"];
+ actor_type: components["parameters"]["api-insights-actor-type"];
/** @description The ID of the actor */
- readonly actor_id: components["parameters"]["api-insights-actor-id"];
+ actor_id: components["parameters"]["api-insights-actor-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-time-stats"];
+ "application/json": components["schemas"]["api-insights-time-stats"];
};
};
};
};
- readonly "api-insights/get-user-stats": {
- readonly parameters: {
- readonly query: {
+ "api-insights/get-user-stats": {
+ parameters: {
+ query: {
/** @description The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly min_timestamp: components["parameters"]["api-insights-min-timestamp"];
+ min_timestamp: components["parameters"]["api-insights-min-timestamp"];
/** @description The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
+ max_timestamp?: components["parameters"]["api-insights-max-timestamp"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["api-insights-sort"];
+ sort?: components["parameters"]["api-insights-sort"];
/** @description Providing a substring will filter results where the actor name contains the substring. This is a case-insensitive search. */
- readonly actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"];
+ actor_name_substring?: components["parameters"]["api-insights-actor-name-substring"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the user to query for stats */
- readonly user_id: components["parameters"]["api-insights-user-id"];
+ user_id: components["parameters"]["api-insights-user-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["api-insights-user-stats"];
+ "application/json": components["schemas"]["api-insights-user-stats"];
};
};
};
};
- readonly "apps/get-org-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/get-org-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["installation"];
+ "application/json": components["schemas"]["installation"];
};
};
};
};
- readonly "orgs/list-app-installations": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-app-installations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly installations: readonly components["schemas"]["installation"][];
+ "application/json": {
+ total_count: number;
+ installations: components["schemas"]["installation"][];
};
};
};
};
};
- readonly "interactions/get-restrictions-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/get-restrictions-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["interaction-limit-response"] | Record;
+ "application/json": components["schemas"]["interaction-limit-response"] | Record;
};
};
};
};
- readonly "interactions/set-restrictions-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/set-restrictions-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["interaction-limit"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["interaction-limit"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["interaction-limit-response"];
+ "application/json": components["schemas"]["interaction-limit-response"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "interactions/remove-restrictions-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/remove-restrictions-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/list-pending-invitations": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-pending-invitations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Filter invitations by their member role. */
- readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager";
+ role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager";
/** @description Filter invitations by their invitation source. */
- readonly invitation_source?: "all" | "member" | "scim";
+ invitation_source?: "all" | "member" | "scim";
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-invitation"][];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/create-invitation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/create-invitation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description **Required unless you provide `email`**. GitHub user ID for the person you are inviting. */
- readonly invitee_id?: number;
+ invitee_id?: number;
/** @description **Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user. */
- readonly email?: string;
+ email?: string;
/**
* @description The role for the new member.
* * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.
@@ -95987,394 +103701,505 @@ export interface operations {
* @default direct_member
* @enum {string}
*/
- readonly role?: "admin" | "direct_member" | "billing_manager" | "reinstate";
+ role?: "admin" | "direct_member" | "billing_manager" | "reinstate";
/** @description Specify IDs for the teams you want to invite new members to. */
- readonly team_ids?: readonly number[];
+ team_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-invitation"];
+ "application/json": components["schemas"]["organization-invitation"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/cancel-invitation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/cancel-invitation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the invitation. */
- readonly invitation_id: components["parameters"]["invitation-id"];
+ invitation_id: components["parameters"]["invitation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/list-invitation-teams": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-invitation-teams": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the invitation. */
- readonly invitation_id: components["parameters"]["invitation-id"];
+ invitation_id: components["parameters"]["invitation-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["team"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/list-issue-types": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue-type"][];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/create-issue-type": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["organization-create-issue-type"];
};
- readonly cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["issue-type"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ "orgs/update-issue-type": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the issue type. */
+ issue_type_id: components["parameters"]["issue-type-id"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["organization-update-issue-type"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue-type"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ };
+ };
+ "orgs/delete-issue-type": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the issue type. */
+ issue_type_id: components["parameters"]["issue-type-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "issues/list-for-org": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-for-org": {
+ parameters: {
+ query?: {
/** @description Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. */
- readonly filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
+ filter?: "assigned" | "created" | "mentioned" | "subscribed" | "repos" | "all";
/** @description Indicates the state of the issues to return. */
- readonly state?: "open" | "closed" | "all";
+ state?: "open" | "closed" | "all";
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
- readonly labels?: components["parameters"]["labels"];
+ labels?: components["parameters"]["labels"];
+ /** @description Can be the name of an issue type. */
+ type?: string;
/** @description What to sort results by. */
- readonly sort?: "created" | "updated" | "comments";
+ sort?: "created" | "updated" | "comments";
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-members": {
- readonly parameters: {
- readonly query?: {
- /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners. */
- readonly filter?: "2fa_disabled" | "all";
+ "orgs/list-members": {
+ parameters: {
+ query?: {
+ /** @description Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only members with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. These options are only available for organization owners. */
+ filter?: "2fa_disabled" | "2fa_insecure" | "all";
/** @description Filter members returned by their role. */
- readonly role?: "all" | "admin" | "member";
+ role?: "all" | "admin" | "member";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/check-membership-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/check-membership-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if requester is an organization member and user is a member */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if requester is not an organization member */
- readonly 302: {
+ 302: {
headers: {
/** @example https://api.github.com/orgs/github/public_members/pezra */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Not Found if requester is an organization member and user is not a member */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/remove-member": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/remove-member": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "codespaces/get-codespaces-for-user-in-org": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/get-codespaces-for-user-in-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly codespaces: readonly components["schemas"]["codespace"][];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
};
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/delete-from-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/delete-from-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
/** @description The name of the codespace. */
- readonly codespace_name: components["parameters"]["codespace-name"];
+ codespace_name: components["parameters"]["codespace-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ requestBody?: never;
+ responses: {
+ 202: components["responses"]["accepted"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/stop-in-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/stop-in-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
/** @description The name of the codespace. */
- readonly codespace_name: components["parameters"]["codespace-name"];
+ codespace_name: components["parameters"]["codespace-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespace"];
+ "application/json": components["schemas"]["codespace"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/get-copilot-seat-details-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "copilot/get-copilot-seat-details-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description The user's GitHub Copilot seat details, including usage. */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["copilot-seat-details"];
+ "application/json": components["schemas"]["copilot-seat-details"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 500: components["responses"]["internal_error"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/get-membership-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-membership-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-membership"];
+ "application/json": components["schemas"]["org-membership"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/set-membership-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/set-membership-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description The role to give the user in the organization. Can be one of:
* * `admin` - The user will become an owner of the organization.
@@ -96382,1997 +104207,2506 @@ export interface operations {
* @default member
* @enum {string}
*/
- readonly role?: "admin" | "member";
+ role?: "admin" | "member";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-membership"];
+ "application/json": components["schemas"]["org-membership"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/remove-membership-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/remove-membership-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/list-for-org": {
- readonly parameters: {
- readonly query?: {
+ "migrations/list-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Exclude attributes from the API response to improve performance */
- readonly exclude?: readonly "repositories"[];
+ exclude?: "repositories"[];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["migration"][];
+ "application/json": components["schemas"]["migration"][];
};
};
};
};
- readonly "migrations/start-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/start-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description A list of arrays indicating which repositories should be migrated. */
- readonly repositories: readonly string[];
+ repositories: string[];
/**
* @description Indicates whether repositories should be locked (to prevent manipulation) while migrating data.
* @default false
* @example true
*/
- readonly lock_repositories?: boolean;
+ lock_repositories?: boolean;
/**
* @description Indicates whether metadata should be excluded and only git source should be included for the migration.
* @default false
*/
- readonly exclude_metadata?: boolean;
+ exclude_metadata?: boolean;
/**
* @description Indicates whether the repository git data should be excluded from the migration.
* @default false
*/
- readonly exclude_git_data?: boolean;
+ exclude_git_data?: boolean;
/**
* @description Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).
* @default false
* @example true
*/
- readonly exclude_attachments?: boolean;
+ exclude_attachments?: boolean;
/**
* @description Indicates whether releases should be excluded from the migration (to reduce migration archive file size).
* @default false
* @example true
*/
- readonly exclude_releases?: boolean;
+ exclude_releases?: boolean;
/**
* @description Indicates whether projects owned by the organization or users should be excluded. from the migration.
* @default false
* @example true
*/
- readonly exclude_owner_projects?: boolean;
+ exclude_owner_projects?: boolean;
/**
* @description Indicates whether this should only include organization metadata (repositories array should be empty and will ignore other flags).
* @default false
* @example true
*/
- readonly org_metadata_only?: boolean;
+ org_metadata_only?: boolean;
/** @description Exclude related items from being returned in the response in order to improve performance of the request. */
- readonly exclude?: readonly "repositories"[];
+ exclude?: "repositories"[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["migration"];
+ "application/json": components["schemas"]["migration"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "migrations/get-status-for-org": {
- readonly parameters: {
- readonly query?: {
+ "migrations/get-status-for-org": {
+ parameters: {
+ query?: {
/** @description Exclude attributes from the API response to improve performance */
- readonly exclude?: readonly "repositories"[];
+ exclude?: "repositories"[];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the migration. */
- readonly migration_id: components["parameters"]["migration-id"];
+ migration_id: components["parameters"]["migration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/**
* @description * `pending`, which means the migration hasn't started yet.
* * `exporting`, which means the migration is in progress.
* * `exported`, which means the migration finished successfully.
* * `failed`, which means the migration failed.
*/
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["migration"];
+ "application/json": components["schemas"]["migration"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/download-archive-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/download-archive-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the migration. */
- readonly migration_id: components["parameters"]["migration-id"];
+ migration_id: components["parameters"]["migration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 302: {
+ 302: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/delete-archive-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/delete-archive-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the migration. */
- readonly migration_id: components["parameters"]["migration-id"];
+ migration_id: components["parameters"]["migration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/unlock-repo-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/unlock-repo-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the migration. */
- readonly migration_id: components["parameters"]["migration-id"];
+ migration_id: components["parameters"]["migration-id"];
/** @description repo_name parameter */
- readonly repo_name: components["parameters"]["repo-name"];
+ repo_name: components["parameters"]["repo-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/list-repos-for-org": {
- readonly parameters: {
- readonly query?: {
+ "migrations/list-repos-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the migration. */
- readonly migration_id: components["parameters"]["migration-id"];
+ migration_id: components["parameters"]["migration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-org-roles": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/list-org-roles": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response - list of organization roles */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/** @description The total number of organization roles available to the organization. */
- readonly total_count?: number;
+ total_count?: number;
/** @description The list of organization roles available to the organization. */
- readonly roles?: readonly components["schemas"]["organization-role"][];
+ roles?: components["schemas"]["organization-role"][];
};
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/revoke-all-org-roles-team": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/revoke-all-org-roles-team": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/assign-team-to-org-role": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/assign-team-to-org-role": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization, team or role does not exist. */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization roles feature is not enabled for the organization, or validation failed. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/revoke-org-role-team": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/revoke-org-role-team": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/revoke-all-org-roles-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/revoke-all-org-roles-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/assign-user-to-org-role": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/assign-user-to-org-role": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization, user or role does not exist. */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization roles feature is not enabled enabled for the organization, the validation failed, or the user is not an organization member. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/revoke-org-role-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/revoke-org-role-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/get-org-role": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-org-role": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["organization-role"];
+ "application/json": components["schemas"]["organization-role"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/list-org-role-teams": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-org-role-teams": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response - List of assigned teams */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team-role-assignment"][];
+ "application/json": components["schemas"]["team-role-assignment"][];
};
};
/** @description Response if the organization or role does not exist. */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization roles feature is not enabled or validation failed. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/list-org-role-users": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-org-role-users": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the role. */
- readonly role_id: components["parameters"]["role-id"];
+ role_id: components["parameters"]["role-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response - List of assigned users */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["user-role-assignment"][];
+ "application/json": components["schemas"]["user-role-assignment"][];
};
};
/** @description Response if the organization or role does not exist. */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if the organization roles feature is not enabled or validation failed. */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/list-outside-collaborators": {
- readonly parameters: {
- readonly query?: {
- /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */
- readonly filter?: "2fa_disabled" | "all";
+ "orgs/list-outside-collaborators": {
+ parameters: {
+ query?: {
+ /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. `2fa_insecure` means that only outside collaborators with [insecure 2FA methods](https://docs.github.com/organizations/keeping-your-organization-secure/managing-two-factor-authentication-for-your-organization/requiring-two-factor-authentication-in-your-organization#requiring-secure-methods-of-two-factor-authentication-in-your-organization) will be returned. */
+ filter?: "2fa_disabled" | "2fa_insecure" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
- readonly "orgs/convert-member-to-outside-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/convert-member-to-outside-collaborator": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.
* @default false
*/
- readonly async?: boolean;
+ async?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description User is getting converted asynchronously */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": Record;
+ "application/json": Record;
};
};
/** @description User was converted */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories)." */
- readonly 403: {
+ 403: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/remove-outside-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/remove-outside-collaborator": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Unprocessable Entity if user is a member of the organization */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
};
};
};
};
};
- readonly "packages/list-packages-for-organization": {
- readonly parameters: {
- readonly query: {
+ "packages/list-packages-for-organization": {
+ parameters: {
+ query: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container";
+ package_type: "npm" | "maven" | "rubygems" | "docker" | "nuget" | "container";
/**
* @description The selected visibility of the packages. This parameter is optional and only filters an existing result set.
*
* The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`.
* For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."
*/
- readonly visibility?: components["parameters"]["package-visibility"];
+ visibility?: components["parameters"]["package-visibility"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: number;
+ page?: number;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
+ per_page?: number;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["package"][];
+ "application/json": components["schemas"]["package"][];
};
};
- readonly 400: components["responses"]["package_es_list_error"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
+ 400: components["responses"]["package_es_list_error"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "packages/get-package-for-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/get-package-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["package"];
+ "application/json": components["schemas"]["package"];
};
};
};
};
- readonly "packages/delete-package-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/delete-package-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "packages/restore-package-for-org": {
- readonly parameters: {
- readonly query?: {
+ "packages/restore-package-for-org": {
+ parameters: {
+ query?: {
/** @description package token */
- readonly token?: string;
+ token?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "packages/get-all-package-versions-for-package-owned-by-org": {
- readonly parameters: {
- readonly query?: {
+ "packages/get-all-package-versions-for-package-owned-by-org": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The state of the package, either active or deleted. */
- readonly state?: "active" | "deleted";
+ state?: "active" | "deleted";
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["package-version"][];
+ "application/json": components["schemas"]["package-version"][];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "packages/get-package-version-for-organization": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/get-package-version-for-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the package version. */
- readonly package_version_id: components["parameters"]["package-version-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["package-version"];
+ "application/json": components["schemas"]["package-version"];
};
};
};
};
- readonly "packages/delete-package-version-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/delete-package-version-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the package version. */
- readonly package_version_id: components["parameters"]["package-version-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "packages/restore-package-version-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "packages/restore-package-version-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. */
- readonly package_type: components["parameters"]["package-type"];
+ package_type: components["parameters"]["package-type"];
/** @description The name of the package. */
- readonly package_name: components["parameters"]["package-name"];
+ package_name: components["parameters"]["package-name"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the package version. */
- readonly package_version_id: components["parameters"]["package-version-id"];
+ package_version_id: components["parameters"]["package-version-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-pat-grant-requests": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-pat-grant-requests": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The property by which to sort the results. */
- readonly sort?: components["parameters"]["personal-access-token-sort"];
+ sort?: components["parameters"]["personal-access-token-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description A list of owner usernames to use to filter the results. */
- readonly owner?: components["parameters"]["personal-access-token-owner"];
+ owner?: components["parameters"]["personal-access-token-owner"];
/** @description The name of the repository to use to filter the results. */
- readonly repository?: components["parameters"]["personal-access-token-repository"];
+ repository?: components["parameters"]["personal-access-token-repository"];
/** @description The permission to use to filter the results. */
- readonly permission?: components["parameters"]["personal-access-token-permission"];
+ permission?: components["parameters"]["personal-access-token-permission"];
/** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly last_used_before?: components["parameters"]["personal-access-token-before"];
+ last_used_before?: components["parameters"]["personal-access-token-before"];
/** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly last_used_after?: components["parameters"]["personal-access-token-after"];
+ last_used_after?: components["parameters"]["personal-access-token-after"];
+ /** @description The ID of the token */
+ token_id?: components["parameters"]["personal-access-token-token-id"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant-request"][];
+ "application/json": components["schemas"]["organization-programmatic-access-grant-request"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/review-pat-grant-requests-in-bulk": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/review-pat-grant-requests-in-bulk": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Unique identifiers of the requests for access via fine-grained personal access token. Must be formed of between 1 and 100 `pat_request_id` values. */
- readonly pat_request_ids?: readonly number[];
+ pat_request_ids?: number[];
/**
* @description Action to apply to the requests.
* @enum {string}
*/
- readonly action: "approve" | "deny";
+ action: "approve" | "deny";
/** @description Reason for approving or denying the requests. Max 1024 characters. */
- readonly reason?: string | null;
+ reason?: string | null;
};
};
};
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/review-pat-grant-request": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/review-pat-grant-request": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the request for access via fine-grained personal access token. */
- readonly pat_request_id: number;
+ pat_request_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Action to apply to the request.
* @enum {string}
*/
- readonly action: "approve" | "deny";
+ action: "approve" | "deny";
/** @description Reason for approving or denying the request. Max 1024 characters. */
- readonly reason?: string | null;
+ reason?: string | null;
};
};
};
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ responses: {
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/list-pat-grant-request-repositories": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-pat-grant-request-repositories": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the request for access via fine-grained personal access token. */
- readonly pat_request_id: number;
+ pat_request_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/list-pat-grants": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-pat-grants": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The property by which to sort the results. */
- readonly sort?: components["parameters"]["personal-access-token-sort"];
+ sort?: components["parameters"]["personal-access-token-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description A list of owner usernames to use to filter the results. */
- readonly owner?: components["parameters"]["personal-access-token-owner"];
+ owner?: components["parameters"]["personal-access-token-owner"];
/** @description The name of the repository to use to filter the results. */
- readonly repository?: components["parameters"]["personal-access-token-repository"];
+ repository?: components["parameters"]["personal-access-token-repository"];
/** @description The permission to use to filter the results. */
- readonly permission?: components["parameters"]["personal-access-token-permission"];
+ permission?: components["parameters"]["personal-access-token-permission"];
/** @description Only show fine-grained personal access tokens used before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly last_used_before?: components["parameters"]["personal-access-token-before"];
+ last_used_before?: components["parameters"]["personal-access-token-before"];
/** @description Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly last_used_after?: components["parameters"]["personal-access-token-after"];
+ last_used_after?: components["parameters"]["personal-access-token-after"];
+ /** @description The ID of the token */
+ token_id?: components["parameters"]["personal-access-token-token-id"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-programmatic-access-grant"][];
+ "application/json": components["schemas"]["organization-programmatic-access-grant"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/update-pat-accesses": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/update-pat-accesses": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Action to apply to the fine-grained personal access token.
* @enum {string}
*/
- readonly action: "revoke";
+ action: "revoke";
/** @description The IDs of the fine-grained personal access tokens. */
- readonly pat_ids: readonly number[];
+ pat_ids: number[];
};
};
};
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ responses: {
+ 202: components["responses"]["accepted"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/update-pat-access": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/update-pat-access": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The unique identifier of the fine-grained personal access token. */
- readonly pat_id: components["parameters"]["fine-grained-personal-access-token-id"];
+ pat_id: components["parameters"]["fine-grained-personal-access-token-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Action to apply to the fine-grained personal access token.
* @enum {string}
*/
- readonly action: "revoke";
+ action: "revoke";
};
};
};
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
+ responses: {
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "orgs/list-pat-grant-repositories": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-pat-grant-repositories": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description Unique identifier of the fine-grained personal access token. */
- readonly pat_id: number;
+ pat_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "private-registries/list-org-private-registries": {
- readonly parameters: {
- readonly query?: {
+ "private-registries/list-org-private-registries": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly configurations: readonly components["schemas"]["org-private-registry-configuration"][];
+ "application/json": {
+ total_count: number;
+ configurations: components["schemas"]["org-private-registry-configuration"][];
};
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "private-registries/create-org-private-registry": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "private-registries/create-org-private-registry": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The registry type.
* @enum {string}
*/
- readonly registry_type: "maven_repository";
+ registry_type: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry";
+ /**
+ * Format: uri
+ * @description The URL of the private registry.
+ */
+ url: string;
/** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */
- readonly username?: string | null;
+ username?: string | null;
+ /**
+ * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
+ * @default false
+ */
+ replaces_base?: boolean;
/** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */
- readonly encrypted_value: string;
+ encrypted_value: string;
/** @description The ID of the key you used to encrypt the secret. */
- readonly key_id: string;
+ key_id: string;
/**
* @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.
* @enum {string}
*/
- readonly visibility: "all" | "private" | "selected";
+ visibility: "all" | "private" | "selected";
/** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. You can manage the list of selected repositories using the [Update a private registry for an organization](https://docs.github.com/rest/private-registries/organization-configurations#update-a-private-registry-for-an-organization) endpoint. This field should be omitted if `visibility` is set to `all` or `private`. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description The organization private registry configuration */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"];
+ "application/json": components["schemas"]["org-private-registry-configuration-with-selected-repositories"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "private-registries/get-org-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "private-registries/get-org-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description The identifier for the key.
* @example 012345678912345678
*/
- readonly key_id: string;
+ key_id: string;
/**
* @description The Base64 encoded public key.
* @example 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234
*/
- readonly key: string;
+ key: string;
};
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "private-registries/get-org-private-registry": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "private-registries/get-org-private-registry": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description The specified private registry configuration for the organization */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["org-private-registry-configuration"];
+ "application/json": components["schemas"]["org-private-registry-configuration"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "private-registries/delete-org-private-registry": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "private-registries/delete-org-private-registry": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "private-registries/update-org-private-registry": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "private-registries/update-org-private-registry": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The registry type.
* @enum {string}
*/
- readonly registry_type?: "maven_repository";
+ registry_type?: "maven_repository" | "nuget_feed" | "goproxy_server" | "npm_registry" | "rubygems_server" | "cargo_registry" | "composer_repository" | "docker_registry" | "git_source" | "helm_registry" | "hex_organization" | "hex_repository" | "pub_repository" | "python_index" | "terraform_registry";
+ /**
+ * Format: uri
+ * @description The URL of the private registry.
+ */
+ url?: string;
/** @description The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication. */
- readonly username?: string | null;
+ username?: string | null;
+ /**
+ * @description Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
+ * @default false
+ */
+ replaces_base?: boolean;
/** @description The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value?: string;
/** @description The ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id?: string;
/**
* @description Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.
* @enum {string}
*/
- readonly visibility?: "all" | "private" | "selected";
+ visibility?: "all" | "private" | "selected";
/** @description An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`. */
- readonly selected_repository_ids?: readonly number[];
+ selected_repository_ids?: number[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "projects/list-for-org": {
- readonly parameters: {
- readonly query?: {
- /** @description Indicates the state of the projects to return. */
- readonly state?: "open" | "closed" | "all";
+ "projects/list-for-org": {
+ parameters: {
+ query?: {
+ /** @description Limit results to projects of the specified type. */
+ q?: string;
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["project"][];
+ "application/json": components["schemas"]["projects-v2"][];
};
};
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "projects/create-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "projects/get-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The name of the project. */
- readonly name: string;
- /** @description The description of the project. */
- readonly body?: string;
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2"];
};
};
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/create-draft-item-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ };
+ cookie?: never;
};
- readonly responses: {
+ /** @description Details of the draft item to create in the project. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The title of the draft issue item to create in the project. */
+ title: string;
+ /** @description The body content of the draft issue item to create in the project. */
+ body?: string;
+ };
+ };
+ };
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["project"];
+ "application/json": components["schemas"]["projects-v2-item-simple"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "orgs/get-all-custom-properties": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "projects/list-fields-for-org": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ };
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["custom-property"][];
+ "application/json": components["schemas"]["projects-v2-field"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "orgs/create-or-update-custom-properties": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "projects/add-field-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The ID of the IssueField to create the field for. */
+ issue_field_id: number;
+ } | {
+ /** @description The name of the field. */
+ name: string;
+ /**
+ * @description The field's data type.
+ * @enum {string}
+ */
+ data_type: "text" | "number" | "date";
+ } | {
+ /** @description The name of the field. */
+ name: string;
+ /**
+ * @description The field's data type.
+ * @enum {string}
+ */
+ data_type: "single_select";
+ /** @description The options available for single select fields. At least one option must be provided when creating a single select field. */
+ single_select_options: components["schemas"]["projects-v2-field-single-select-option"][];
+ } | {
+ /** @description The name of the field. */
+ name: string;
+ /**
+ * @description The field's data type.
+ * @enum {string}
+ */
+ data_type: "iteration";
+ iteration_configuration: components["schemas"]["projects-v2-field-iteration-configuration"];
+ };
+ };
+ };
+ responses: {
+ /** @description Response for adding a field to an organization-owned project. */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-field"];
+ };
};
- readonly cookie?: never;
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ };
+ "projects/get-field-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The unique identifier of the field. */
+ field_id: components["parameters"]["field-id"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-field"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/list-items-for-org": {
+ parameters: {
+ query?: {
+ /** @description Search query to filter items, see [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information. */
+ q?: string;
+ /**
+ * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
+ *
+ * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`
+ */
+ fields?: string | string[];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ };
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-item-with-content"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/add-item-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ };
+ cookie?: never;
+ };
+ /** @description Details of the item to add to the project. You can specify either the unique ID or the repository owner, name, and issue/PR number. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The type of item to add to the project. Must be either Issue or PullRequest.
+ * @enum {string}
+ */
+ type: "Issue" | "PullRequest";
+ /** @description The unique identifier of the issue or pull request to add to the project. */
+ id?: number;
+ /** @description The repository owner login. */
+ owner?: string;
+ /** @description The repository name. */
+ repo?: string;
+ /** @description The issue or pull request number. */
+ number?: number;
+ } & (unknown | unknown);
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-item-simple"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/get-org-item": {
+ parameters: {
+ query?: {
+ /**
+ * @description Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
+ *
+ * Example: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
+ */
+ fields?: string | string[];
+ };
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the project item. */
+ item_id: components["parameters"]["item-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-item-with-content"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/delete-item-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the project item. */
+ item_id: components["parameters"]["item-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ };
+ };
+ "projects/update-item-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the project item. */
+ item_id: components["parameters"]["item-id"];
+ };
+ cookie?: never;
+ };
+ /** @description Field updates to apply to the project item. Only text, number, date, single select, and iteration fields are supported. */
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description A list of field updates to apply. */
+ fields: {
+ /** @description The ID of the project field to update. */
+ id: number;
+ /**
+ * @description The new value for the field:
+ * - For text, number, and date fields, provide the new value directly.
+ * - For single select and iteration fields, provide the ID of the option or iteration.
+ * - To clear the field, set this to null.
+ */
+ value: (string | number) | null;
+ }[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-item-with-content"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "projects/create-view-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /**
+ * @description The name of the view.
+ * @example Sprint Board
+ */
+ name: string;
+ /**
+ * @description The layout of the view.
+ * @example board
+ * @enum {string}
+ */
+ layout: "table" | "board" | "roadmap";
+ /**
+ * @description The filter query for the view. See [Filtering projects](https://docs.github.com/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/filtering-projects) for more information.
+ * @example is:issue is:open
+ */
+ filter?: string;
+ /**
+ * @description `visible_fields` is not applicable to `roadmap` layout views.
+ * For `table` and `board` layouts, this represents the field IDs that should be visible in the view. If not provided, the default visible fields will be used.
+ * @example [
+ * 123,
+ * 456,
+ * 789
+ * ]
+ */
+ visible_fields?: number[];
+ };
+ };
+ };
+ responses: {
+ /** @description Response for creating a view in an organization-owned project. */
+ 201: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-view"];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ /** @description Service unavailable */
+ 503: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["basic-error"];
+ };
+ };
+ };
+ };
+ "projects/list-view-items-for-org": {
+ parameters: {
+ query?: {
+ /**
+ * @description Limit results to specific fields, by their IDs. If not specified, the
+ * title field will be returned.
+ *
+ * Example: `fields[]=123&fields[]=456&fields[]=789` or `fields=123,456,789`
+ */
+ fields?: string | string[];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ };
+ header?: never;
+ path: {
+ /** @description The project's number. */
+ project_number: components["parameters"]["project-number"];
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The number that identifies the project view. */
+ view_number: components["parameters"]["view-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["projects-v2-item-with-content"][];
+ };
+ };
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/custom-properties-for-repos-get-organization-definitions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["custom-property"][];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "orgs/custom-properties-for-repos-create-or-update-organization-definitions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The array of custom properties to create or update. */
- readonly properties: readonly components["schemas"]["custom-property"][];
+ properties: components["schemas"]["custom-property"][];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["custom-property"][];
+ "application/json": components["schemas"]["custom-property"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/get-custom-property": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/custom-properties-for-repos-get-organization-definition": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The custom property name */
- readonly custom_property_name: components["parameters"]["custom-property-name"];
+ custom_property_name: components["parameters"]["custom-property-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["custom-property"];
+ "application/json": components["schemas"]["custom-property"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/create-or-update-custom-property": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/custom-properties-for-repos-create-or-update-organization-definition": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The custom property name */
- readonly custom_property_name: components["parameters"]["custom-property-name"];
+ custom_property_name: components["parameters"]["custom-property-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["custom-property-set-payload"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["custom-property-set-payload"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["custom-property"];
+ "application/json": components["schemas"]["custom-property"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/remove-custom-property": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/custom-properties-for-repos-delete-organization-definition": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The custom property name */
- readonly custom_property_name: components["parameters"]["custom-property-name"];
+ custom_property_name: components["parameters"]["custom-property-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 204: components["responses"]["no_content"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ requestBody?: never;
+ responses: {
+ 204: components["responses"]["no_content"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/list-custom-properties-values-for-repos": {
- readonly parameters: {
- readonly query?: {
+ "orgs/custom-properties-for-repos-get-organization-values": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */
- readonly repository_query?: string;
+ repository_query?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["org-repo-custom-property-values"][];
+ "application/json": components["schemas"]["org-repo-custom-property-values"][];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/create-or-update-custom-properties-values-for-repos": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/custom-properties-for-repos-create-or-update-organization-values": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of repositories that the custom property values will be applied to. */
- readonly repository_names: readonly string[];
+ repository_names: string[];
/** @description List of custom property names and associated values to apply to the repositories. */
- readonly properties: readonly components["schemas"]["custom-property-value"][];
+ properties: components["schemas"]["custom-property-value"][];
};
};
};
- readonly responses: {
+ responses: {
/** @description No Content when custom property values are successfully created or updated */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "orgs/list-public-members": {
- readonly parameters: {
- readonly query?: {
+ "orgs/list-public-members": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
- readonly "orgs/check-public-membership-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/check-public-membership-for-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if user is a public member */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Not Found if user is not a public member */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "orgs/set-public-membership-for-authenticated-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/set-public-membership-for-authenticated-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "orgs/remove-public-membership-for-authenticated-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/remove-public-membership-for-authenticated-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-for-org": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-for-org": {
+ parameters: {
+ query?: {
/** @description Specifies the types of repositories you want returned. */
- readonly type?: "all" | "public" | "private" | "forks" | "sources" | "member";
+ type?: "all" | "public" | "private" | "forks" | "sources" | "member";
/** @description The property to sort the results by. */
- readonly sort?: "created" | "updated" | "pushed" | "full_name";
+ sort?: "created" | "updated" | "pushed" | "full_name";
/** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */
- readonly direction?: "asc" | "desc";
+ direction?: "asc" | "desc";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
};
};
- readonly "repos/create-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the repository. */
- readonly name: string;
+ name: string;
/** @description A short description of the repository. */
- readonly description?: string;
+ description?: string;
/** @description A URL with more information about the repository. */
- readonly homepage?: string;
+ homepage?: string;
/**
* @description Whether the repository is private.
* @default false
*/
- readonly private?: boolean;
+ private?: boolean;
/**
* @description The visibility of the repository.
* @enum {string}
*/
- readonly visibility?: "public" | "private";
+ visibility?: "public" | "private";
/**
* @description Either `true` to enable issues for this repository or `false` to disable them.
* @default true
*/
- readonly has_issues?: boolean;
+ has_issues?: boolean;
/**
* @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
* @default true
*/
- readonly has_projects?: boolean;
+ has_projects?: boolean;
/**
* @description Either `true` to enable the wiki for this repository or `false` to disable it.
* @default true
*/
- readonly has_wiki?: boolean;
+ has_wiki?: boolean;
/**
* @description Whether downloads are enabled.
* @default true
* @example true
*/
- readonly has_downloads?: boolean;
+ has_downloads?: boolean;
/**
* @description Either `true` to make this repo available as a template repository or `false` to prevent it.
* @default false
*/
- readonly is_template?: boolean;
+ is_template?: boolean;
/** @description The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. */
- readonly team_id?: number;
+ team_id?: number;
/**
* @description Pass `true` to create an initial commit with empty README.
* @default false
*/
- readonly auto_init?: boolean;
+ auto_init?: boolean;
/** @description Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". */
- readonly gitignore_template?: string;
+ gitignore_template?: string;
/** @description Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, "mit" or "mpl-2.0". */
- readonly license_template?: string;
+ license_template?: string;
/**
* @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
* @default true
*/
- readonly allow_squash_merge?: boolean;
+ allow_squash_merge?: boolean;
/**
* @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
* @default true
*/
- readonly allow_merge_commit?: boolean;
+ allow_merge_commit?: boolean;
/**
* @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
* @default true
*/
- readonly allow_rebase_merge?: boolean;
+ allow_rebase_merge?: boolean;
/**
* @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
* @default false
*/
- readonly allow_auto_merge?: boolean;
+ allow_auto_merge?: boolean;
/**
* @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. **The authenticated user must be an organization owner to set this property to `true`.**
* @default false
*/
- readonly delete_branch_on_merge?: boolean;
+ delete_branch_on_merge?: boolean;
/**
* @deprecated
* @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default?: boolean;
+ use_squash_pr_title_as_default?: boolean;
/**
* @description Required when using `squash_merge_commit_message`.
*
@@ -98382,7 +106716,7 @@ export interface operations {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -98391,7 +106725,7 @@ export interface operations {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description Required when using `merge_commit_message`.
*
@@ -98401,7 +106735,7 @@ export interface operations {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -98410,2942 +106744,1713 @@ export interface operations {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/** @description The custom properties for the new repository. The keys are the custom property names, and the values are the corresponding custom property values. */
- readonly custom_properties?: {
- readonly [key: string]: unknown;
+ custom_properties?: {
+ [key: string]: unknown;
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["full-repository"];
+ "application/json": components["schemas"]["full-repository"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-org-rulesets": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-org-rulesets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/**
* @description A comma-separated list of rule targets to filter by.
* If provided, only rulesets that apply to the specified targets will be returned.
* For example, `branch,tag,push`.
*/
- readonly targets?: components["parameters"]["ruleset-targets"];
+ targets?: components["parameters"]["ruleset-targets"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["repository-ruleset"][];
+ "application/json": components["schemas"]["repository-ruleset"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/create-org-ruleset": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-org-ruleset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
/** @description Request body */
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the ruleset. */
- readonly name: string;
+ name: string;
/**
* @description The target of the ruleset
* @default branch
* @enum {string}
*/
- readonly target?: "branch" | "tag" | "push" | "repository";
- readonly enforcement: components["schemas"]["repository-rule-enforcement"];
+ target?: "branch" | "tag" | "push" | "repository";
+ enforcement: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
- readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][];
- readonly conditions?: components["schemas"]["org-ruleset-conditions"];
+ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
+ conditions?: components["schemas"]["org-ruleset-conditions"];
/** @description An array of rules within the ruleset. */
- readonly rules?: readonly components["schemas"]["repository-rule"][];
+ rules?: components["schemas"]["org-rules"][];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-ruleset"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/get-org-rule-suites": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-org-rule-suites": {
+ parameters: {
+ query?: {
/** @description The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. */
- readonly ref?: components["parameters"]["ref-in-query"];
+ ref?: components["parameters"]["ref-in-query"];
/** @description The name of the repository to filter on. */
- readonly repository_name?: components["parameters"]["repository-name-in-query"];
+ repository_name?: components["parameters"]["repository-name-in-query"];
/**
* @description The time period to filter by.
*
- * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).
+ * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for rule suites that occurred in the past 7 days (168 hours).
*/
- readonly time_period?: components["parameters"]["time-period"];
+ time_period?: components["parameters"]["time-period"];
/** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */
- readonly actor_name?: components["parameters"]["actor-name-in-query"];
- /** @description The rule results to filter on. When specified, only suites with this result will be returned. */
- readonly rule_suite_result?: components["parameters"]["rule-suite-result"];
+ actor_name?: components["parameters"]["actor-name-in-query"];
+ /** @description The rule suite results to filter on. When specified, only suites with this result will be returned. */
+ rule_suite_result?: components["parameters"]["rule-suite-result"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["rule-suites"];
+ "application/json": components["schemas"]["rule-suites"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/get-org-rule-suite": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-org-rule-suite": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/**
* @description The unique identifier of the rule suite result.
* To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)
* for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)
* for organizations.
*/
- readonly rule_suite_id: components["parameters"]["rule-suite-id"];
+ rule_suite_id: components["parameters"]["rule-suite-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["rule-suite"];
+ "application/json": components["schemas"]["rule-suite"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/get-org-ruleset": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-org-ruleset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the ruleset. */
- readonly ruleset_id: number;
+ ruleset_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-ruleset"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/update-org-ruleset": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-org-ruleset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the ruleset. */
- readonly ruleset_id: number;
+ ruleset_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
/** @description Request body */
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The name of the ruleset. */
- readonly name?: string;
+ name?: string;
/**
* @description The target of the ruleset
* @enum {string}
*/
- readonly target?: "branch" | "tag" | "push" | "repository";
- readonly enforcement?: components["schemas"]["repository-rule-enforcement"];
+ target?: "branch" | "tag" | "push" | "repository";
+ enforcement?: components["schemas"]["repository-rule-enforcement"];
/** @description The actors that can bypass the rules in this ruleset */
- readonly bypass_actors?: readonly components["schemas"]["repository-ruleset-bypass-actor"][];
- readonly conditions?: components["schemas"]["org-ruleset-conditions"];
+ bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][];
+ conditions?: components["schemas"]["org-ruleset-conditions"];
/** @description An array of rules within the ruleset. */
- readonly rules?: readonly components["schemas"]["repository-rule"][];
+ rules?: components["schemas"]["org-rules"][];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-ruleset"];
+ "application/json": components["schemas"]["repository-ruleset"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/delete-org-ruleset": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-org-ruleset": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The ID of the ruleset. */
- readonly ruleset_id: number;
+ ruleset_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "secret-scanning/list-alerts-for-org": {
- readonly parameters: {
- readonly query?: {
- /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
- readonly state?: components["parameters"]["secret-scanning-alert-state"];
- /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return experimental patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */
- readonly secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
- /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
- readonly resolution?: components["parameters"]["secret-scanning-alert-resolution"];
- /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
- readonly sort?: components["parameters"]["secret-scanning-alert-sort"];
- /** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ "orgs/get-org-ruleset-history": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
- readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
- readonly after?: components["parameters"]["secret-scanning-pagination-after-org-repo"];
- /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
- readonly validity?: components["parameters"]["secret-scanning-alert-validity"];
- /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */
- readonly is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"];
- /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */
- readonly is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"];
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
+ /** @description The organization name. The name is not case sensitive. */
+ org: components["parameters"]["org"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["ruleset-version"][];
+ };
};
- readonly header?: never;
- readonly path: {
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ };
+ };
+ "orgs/get-org-ruleset-version": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ /** @description The ID of the ruleset. */
+ ruleset_id: number;
+ /** @description The ID of the version */
+ version_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-secret-scanning-alert"][];
+ "application/json": components["schemas"]["ruleset-version-with-state"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "security-advisories/list-org-repository-advisories": {
- readonly parameters: {
- readonly query?: {
+ "secret-scanning/list-alerts-for-org": {
+ parameters: {
+ query?: {
+ /** @description Set to `open` or `resolved` to only list secret scanning alerts in a specific state. */
+ state?: components["parameters"]["secret-scanning-alert-state"];
+ /** @description A comma-separated list of secret types to return. All default secret patterns are returned. To return generic patterns, pass the token name(s) in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)" for a complete list of secret types. */
+ secret_type?: components["parameters"]["secret-scanning-alert-secret-type"];
+ /** @description A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. */
+ resolution?: components["parameters"]["secret-scanning-alert-resolution"];
+ /** @description Filters alerts by assignee. Use `*` to get all assigned alerts, `none` to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user. */
+ assignee?: components["parameters"]["secret-scanning-alert-assignee"];
+ /** @description The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. */
+ sort?: components["parameters"]["secret-scanning-alert-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
- /** @description The property to sort the results by. */
- readonly sort?: "created" | "updated" | "published";
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
- /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
- /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
- /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */
- readonly state?: "triage" | "draft" | "published" | "closed";
+ direction?: components["parameters"]["direction"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */
+ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */
+ after?: components["parameters"]["secret-scanning-pagination-after-org-repo"];
+ /** @description A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */
+ validity?: components["parameters"]["secret-scanning-alert-validity"];
+ /** @description A boolean value representing whether or not to filter alerts by the publicly-leaked tag being present. */
+ is_publicly_leaked?: components["parameters"]["secret-scanning-alert-publicly-leaked"];
+ /** @description A boolean value representing whether or not to filter alerts by the multi-repo tag being present. */
+ is_multi_repo?: components["parameters"]["secret-scanning-alert-multi-repo"];
+ /** @description A boolean value representing whether or not to hide literal secrets in the results. */
+ hide_secret?: components["parameters"]["secret-scanning-alert-hide-secret"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["repository-advisory"][];
+ "application/json": components["schemas"]["organization-secret-scanning-alert"][];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "orgs/list-security-manager-teams": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "secret-scanning/list-org-pattern-configs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team-simple"][];
+ "application/json": components["schemas"]["secret-scanning-pattern-configuration"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "orgs/add-security-manager-team": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "secret-scanning/update-org-pattern-configs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
+ org: components["parameters"]["org"];
};
+ cookie?: never;
};
- };
- readonly "orgs/remove-security-manager-team": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
+ requestBody: {
+ content: {
+ "application/json": {
+ pattern_config_version?: components["schemas"]["secret-scanning-row-version"];
+ /** @description Pattern settings for provider patterns. */
+ provider_pattern_settings?: {
+ /** @description The ID of the pattern to configure. */
+ token_type?: string;
+ /**
+ * @description Push protection setting to set for the pattern.
+ * @enum {string}
+ */
+ push_protection_setting?: "not-set" | "disabled" | "enabled";
+ }[];
+ /** @description Pattern settings for custom patterns. */
+ custom_pattern_settings?: {
+ /** @description The ID of the pattern to configure. */
+ token_type?: string;
+ custom_pattern_version?: components["schemas"]["secret-scanning-row-version"];
+ /**
+ * @description Push protection setting to set for the pattern.
+ * @enum {string}
+ */
+ push_protection_setting?: "disabled" | "enabled";
+ }[];
};
- content?: never;
};
};
- };
- readonly "billing/get-github-actions-billing-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-billing-usage"];
+ "application/json": {
+ /** @description The updated pattern configuration version. */
+ pattern_config_version?: string;
+ };
};
};
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "billing/get-github-packages-billing-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "security-advisories/list-org-repository-advisories": {
+ parameters: {
+ query?: {
+ /** @description The direction to sort the results by. */
+ direction?: components["parameters"]["direction"];
+ /** @description The property to sort the results by. */
+ sort?: "created" | "updated" | "published";
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ before?: components["parameters"]["pagination-before"];
+ /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
+ /** @description Filter by the state of the repository advisories. Only advisories of this state will be returned. */
+ state?: "triage" | "draft" | "published" | "closed";
+ };
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["packages-billing-usage"];
+ "application/json": components["schemas"]["repository-advisory"][];
};
};
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "billing/get-shared-storage-billing-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/list-security-manager-teams": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["combined-billing-usage"];
+ "application/json": components["schemas"]["team-simple"][];
};
};
};
};
- readonly "hosted-compute/list-network-configurations-for-org": {
- readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
+ "orgs/add-security-manager-team": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
+ /** @description The slug of the team name. */
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly network_configurations: readonly components["schemas"]["network-configuration"][];
- };
+ [name: string]: unknown;
};
+ content?: never;
};
};
};
- readonly "hosted-compute/create-network-configuration-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/remove-security-manager-team": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
- readonly name: string;
- /**
- * @description The hosted compute service to use for the network configuration.
- * @enum {string}
- */
- readonly compute_service?: "none" | "actions";
- /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */
- readonly network_settings_ids: readonly string[];
- };
+ org: components["parameters"]["org"];
+ /** @description The slug of the team name. */
+ team_slug: components["parameters"]["team-slug"];
};
+ cookie?: never;
};
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["network-configuration"];
+ [name: string]: unknown;
};
+ content?: never;
};
};
};
- readonly "hosted-compute/get-network-configuration-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/get-immutable-releases-settings": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description Unique identifier of the hosted compute network configuration. */
- readonly network_configuration_id: components["parameters"]["network-configuration-id"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ requestBody?: never;
+ responses: {
+ /** @description Immutable releases settings response */
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["network-configuration"];
- };
- };
- };
- };
- readonly "hosted-compute/delete-network-configuration-from-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description Unique identifier of the hosted compute network configuration. */
- readonly network_configuration_id: components["parameters"]["network-configuration-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
+ "application/json": components["schemas"]["immutable-releases-organization-settings"];
};
- content?: never;
};
};
};
- readonly "hosted-compute/update-network-configuration-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/set-immutable-releases-settings": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description Unique identifier of the hosted compute network configuration. */
- readonly network_configuration_id: components["parameters"]["network-configuration-id"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
- readonly name?: string;
+ requestBody: {
+ content: {
+ "application/json": {
/**
- * @description The hosted compute service to use for the network configuration.
+ * @description The policy that controls how immutable releases are enforced in the organization.
+ * @example all
* @enum {string}
*/
- readonly compute_service?: "none" | "actions";
- /** @description The identifier of the network settings to use for the network configuration. Exactly one network settings must be specified. */
- readonly network_settings_ids?: readonly string[];
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["network-configuration"];
+ enforced_repositories: "all" | "none" | "selected";
+ /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */
+ selected_repository_ids?: number[];
};
};
};
- };
- readonly "hosted-compute/get-network-settings-for-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description Unique identifier of the hosted compute network settings. */
- readonly network_settings_id: components["parameters"]["network-settings-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["network-settings"];
- };
- };
- };
- };
- readonly "copilot/copilot-metrics-for-team": {
- readonly parameters: {
- readonly query?: {
- /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
- readonly since?: string;
- /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
- readonly until?: string;
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
- };
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["copilot-usage-metrics-day"][];
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["usage_metrics_api_disabled"];
- readonly 500: components["responses"]["internal_error"];
};
};
- readonly "copilot/usage-metrics-for-team": {
- readonly parameters: {
- readonly query?: {
- /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. */
- readonly since?: string;
- /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
- readonly until?: string;
+ "orgs/get-immutable-releases-settings-repositories": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- /** @description The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: number;
- };
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["copilot-usage-metrics"][];
- };
- };
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
- };
- };
- readonly "teams/list": {
- readonly parameters: {
- readonly query?: {
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": {
+ total_count: number;
+ repositories: components["schemas"]["minimal-repository"][];
+ };
};
};
- readonly 403: components["responses"]["forbidden"];
};
};
- readonly "teams/create": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/set-immutable-releases-settings-repositories": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The name of the team. */
- readonly name: string;
- /** @description The description of the team. */
- readonly description?: string;
- /** @description List GitHub IDs for organization members who will become team maintainers. */
- readonly maintainers?: readonly string[];
- /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */
- readonly repo_names?: readonly string[];
- /**
- * @description The level of privacy this team should have. The options are:
- * **For a non-nested team:**
- * * `secret` - only visible to organization owners and members of this team.
- * * `closed` - visible to all members of this organization.
- * Default: `secret`
- * **For a parent or child team:**
- * * `closed` - visible to all members of this organization.
- * Default for child team: `closed`
- * @enum {string}
- */
- readonly privacy?: "secret" | "closed";
- /**
- * @description The notification setting the team has chosen. The options are:
- * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
- * * `notifications_disabled` - no one receives notifications.
- * Default: `notifications_enabled`
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /**
- * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified.
- * @default pull
- * @enum {string}
- */
- readonly permission?: "pull" | "push";
- /** @description The ID of a team to set as the parent team. */
- readonly parent_team_id?: number;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-full"];
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description An array of repository ids for which immutable releases enforcement should be applied. You can only provide a list of repository ids when the `enforced_repositories` is set to `selected`. You can add and remove individual repositories using the [Enable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#enable-a-selected-repository-for-immutable-releases-in-an-organization) and [Disable a selected repository for immutable releases in an organization](https://docs.github.com/rest/orgs/orgs#disable-a-selected-repository-for-immutable-releases-in-an-organization) endpoints. */
+ selected_repository_ids: number[];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
};
- };
- readonly "teams/get-by-name": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-full"];
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 404: components["responses"]["not_found"];
};
};
- readonly "teams/delete-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/enable-selected-repository-immutable-releases-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the repository. */
+ repository_id: components["parameters"]["repository-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/update-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/disable-selected-repository-immutable-releases-organization": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /** @description The name of the team. */
- readonly name?: string;
- /** @description The description of the team. */
- readonly description?: string;
- /**
- * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are:
- * **For a non-nested team:**
- * * `secret` - only visible to organization owners and members of this team.
- * * `closed` - visible to all members of this organization.
- * **For a parent or child team:**
- * * `closed` - visible to all members of this organization.
- * @enum {string}
- */
- readonly privacy?: "secret" | "closed";
- /**
- * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are:
- * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
- * * `notifications_disabled` - no one receives notifications.
- * @enum {string}
- */
- readonly notification_setting?: "notifications_enabled" | "notifications_disabled";
- /**
- * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified.
- * @default pull
- * @enum {string}
- */
- readonly permission?: "pull" | "push" | "admin";
- /** @description The ID of a team to set as the parent team. */
- readonly parent_team_id?: number | null;
- };
+ org: components["parameters"]["org"];
+ /** @description The unique identifier of the repository. */
+ repository_id: components["parameters"]["repository-id"];
};
+ cookie?: never;
};
- readonly responses: {
- /** @description Response when the updated information already exists */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-full"];
- };
- };
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-full"];
+ [name: string]: unknown;
};
+ content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "teams/list-discussions-in-org": {
- readonly parameters: {
- readonly query?: {
- /** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ "hosted-compute/list-network-configurations-for-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- /** @description Pinned discussions only filter */
- readonly pinned?: string;
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team-discussion"][];
+ "application/json": {
+ total_count: number;
+ network_configurations: components["schemas"]["network-configuration"][];
+ };
};
};
};
};
- readonly "teams/create-discussion-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "hosted-compute/create-network-configuration-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The discussion post's title. */
- readonly title: string;
- /** @description The discussion post's body text. */
- readonly body: string;
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
+ name: string;
/**
- * @description Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.
- * @default false
+ * @description The hosted compute service to use for the network configuration.
+ * @enum {string}
*/
- readonly private?: boolean;
+ compute_service?: "none" | "actions";
+ /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */
+ network_settings_ids: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-discussion"];
+ "application/json": components["schemas"]["network-configuration"];
};
};
};
};
- readonly "teams/get-discussion-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "hosted-compute/get-network-configuration-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
+ org: components["parameters"]["org"];
+ /** @description Unique identifier of the hosted compute network configuration. */
+ network_configuration_id: components["parameters"]["network-configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-discussion"];
+ "application/json": components["schemas"]["network-configuration"];
};
};
};
};
- readonly "teams/delete-discussion-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "hosted-compute/delete-network-configuration-from-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
+ org: components["parameters"]["org"];
+ /** @description Unique identifier of the hosted compute network configuration. */
+ network_configuration_id: components["parameters"]["network-configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/update-discussion-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "hosted-compute/update-network-configuration-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /** @description The discussion post's title. */
- readonly title?: string;
- /** @description The discussion post's body text. */
- readonly body?: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-discussion"];
- };
- };
- };
- };
- readonly "teams/list-discussion-comments-in-org": {
- readonly parameters: {
- readonly query?: {
- /** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["team-discussion-comment"][];
- };
- };
- };
- };
- readonly "teams/create-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
+ org: components["parameters"]["org"];
+ /** @description Unique identifier of the hosted compute network configuration. */
+ network_configuration_id: components["parameters"]["network-configuration-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The discussion comment's body text. */
- readonly body: string;
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description Name of the network configuration. Must be between 1 and 100 characters and may only contain upper and lowercase letters a-z, numbers 0-9, '.', '-', and '_'. */
+ name?: string;
+ /**
+ * @description The hosted compute service to use for the network configuration.
+ * @enum {string}
+ */
+ compute_service?: "none" | "actions";
+ /** @description A list of identifiers of the network settings resources to use for the network configuration. Exactly one resource identifier must be specified in the list. */
+ network_settings_ids?: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-discussion-comment"];
+ "application/json": components["schemas"]["network-configuration"];
};
};
};
};
- readonly "teams/get-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "hosted-compute/get-network-settings-for-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
+ org: components["parameters"]["org"];
+ /** @description Unique identifier of the hosted compute network settings. */
+ network_settings_id: components["parameters"]["network-settings-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-discussion-comment"];
+ "application/json": components["schemas"]["network-settings"];
};
};
};
};
- readonly "teams/delete-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
+ "copilot/copilot-metrics-for-team": {
+ parameters: {
+ query?: {
+ /** @description Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 100 days ago. */
+ since?: string;
+ /** @description Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. */
+ until?: string;
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ /** @description The number of days of metrics to display per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: number;
};
- };
- };
- readonly "teams/update-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The discussion comment's body text. */
- readonly body: string;
- };
+ team_slug: components["parameters"]["team-slug"];
};
+ cookie?: never;
};
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-discussion-comment"];
+ "application/json": components["schemas"]["copilot-usage-metrics-day"][];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["usage_metrics_api_disabled"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "reactions/list-for-team-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: {
- /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */
- readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ "teams/list": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["team"][];
};
};
+ 403: components["responses"]["forbidden"];
};
};
- readonly "reactions/create-for-team-discussion-comment-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/create": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
+ org: components["parameters"]["org"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The name of the team. */
+ name: string;
+ /** @description The description of the team. */
+ description?: string;
+ /** @description List GitHub usernames for organization members who will become team maintainers. */
+ maintainers?: string[];
+ /** @description The full name (e.g., "organization-name/repository-name") of repositories to add the team to. */
+ repo_names?: string[];
/**
- * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion comment.
+ * @description The level of privacy this team should have. The options are:
+ * **For a non-nested team:**
+ * * `secret` - only visible to organization owners and members of this team.
+ * * `closed` - visible to all members of this organization.
+ * Default: `secret`
+ * **For a parent or child team:**
+ * * `closed` - visible to all members of this organization.
+ * Default for child team: `closed`
+ * @enum {string}
+ */
+ privacy?: "secret" | "closed";
+ /**
+ * @description The notification setting the team has chosen. The options are:
+ * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
+ * * `notifications_disabled` - no one receives notifications.
+ * Default: `notifications_enabled`
* @enum {string}
*/
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /**
+ * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified.
+ * @default pull
+ * @enum {string}
+ */
+ permission?: "pull" | "push";
+ /** @description The ID of a team to set as the parent team. */
+ parent_team_id?: number;
};
};
};
- readonly responses: {
- /** @description Response when the reaction type has already been added to this team discussion comment */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["reaction"];
- };
- };
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["team-full"];
};
};
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/delete-for-team-discussion-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/get-by-name": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The number that identifies the comment. */
- readonly comment_number: components["parameters"]["comment-number"];
- /** @description The unique identifier of the reaction. */
- readonly reaction_id: components["parameters"]["reaction-id"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["team-full"];
};
- content?: never;
};
+ 404: components["responses"]["not_found"];
};
};
- readonly "reactions/list-for-team-discussion-in-org": {
- readonly parameters: {
- readonly query?: {
- /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */
- readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
+ "teams/delete-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["reaction"][];
+ [name: string]: unknown;
};
+ content?: never;
};
+ 422: components["responses"]["enterprise_team_unsupported"];
};
};
- readonly "reactions/create-for-team-discussion-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/update-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The name of the team. */
+ name?: string;
+ /** @description The description of the team. */
+ description?: string;
+ /**
+ * @description The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are:
+ * **For a non-nested team:**
+ * * `secret` - only visible to organization owners and members of this team.
+ * * `closed` - visible to all members of this organization.
+ * **For a parent or child team:**
+ * * `closed` - visible to all members of this organization.
+ * @enum {string}
+ */
+ privacy?: "secret" | "closed";
/**
- * @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the team discussion.
+ * @description The notification setting the team has chosen. Editing teams without specifying this parameter leaves `notification_setting` intact. The options are:
+ * * `notifications_enabled` - team members receive notifications when the team is @mentioned.
+ * * `notifications_disabled` - no one receives notifications.
+ * @enum {string}
+ */
+ notification_setting?: "notifications_enabled" | "notifications_disabled";
+ /**
+ * @description **Closing down notice**. The permission that new repositories will be added to the team with when none is specified.
+ * @default pull
* @enum {string}
*/
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ permission?: "pull" | "push" | "admin";
+ /** @description The ID of a team to set as the parent team. */
+ parent_team_id?: number | null;
};
};
};
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ responses: {
+ /** @description Response when the updated information already exists */
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["team-full"];
};
};
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["team-full"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/delete-for-team-discussion": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The number that identifies the discussion. */
- readonly discussion_number: components["parameters"]["discussion-number"];
- /** @description The unique identifier of the reaction. */
- readonly reaction_id: components["parameters"]["reaction-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "teams/list-pending-invitations-in-org": {
- readonly parameters: {
- readonly query?: {
+ "teams/list-pending-invitations-in-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["organization-invitation"][];
+ "application/json": components["schemas"]["organization-invitation"][];
};
};
+ 422: components["responses"]["enterprise_team_unsupported"];
};
};
- readonly "teams/list-members-in-org": {
- readonly parameters: {
- readonly query?: {
+ "teams/list-members-in-org": {
+ parameters: {
+ query?: {
/** @description Filters members returned by their role in the team. */
- readonly role?: "member" | "maintainer" | "all";
+ role?: "member" | "maintainer" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
};
};
- readonly "teams/get-membership-for-user-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/get-membership-for-user-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-membership"];
+ "application/json": components["schemas"]["team-membership"];
};
};
/** @description if user has no team membership */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/add-or-update-membership-for-user-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/add-or-update-membership-for-user-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description The role that this user should have in the team.
* @default member
* @enum {string}
*/
- readonly role?: "member" | "maintainer";
+ role?: "member" | "maintainer";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-membership"];
+ "application/json": components["schemas"]["team-membership"];
};
};
/** @description Forbidden if team synchronization is set up */
- readonly 403: {
+ 403: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Unprocessable Entity if you attempt to add an organization to a team */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/remove-membership-for-user-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/remove-membership-for-user-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Forbidden if team synchronization is set up */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "teams/list-projects-in-org": {
- readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["team-project"][];
- };
- };
- };
- };
- readonly "teams/check-permissions-for-project-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
+ 403: {
headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["team-project"];
- };
- };
- /** @description Not Found if project is not managed by this team */
- readonly 404: {
- headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/add-or-update-project-permissions-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."
- * @enum {string}
- */
- readonly permission?: "read" | "write" | "admin";
- } | null;
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- /** @description Forbidden if the project is not owned by the organization */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
- };
- };
- };
- };
- };
- readonly "teams/remove-project-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
- /** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- };
- };
- readonly "teams/list-repos-in-org": {
- readonly parameters: {
- readonly query?: {
+ "teams/list-repos-in-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
};
};
- readonly "teams/check-permissions-for-repo-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/check-permissions-for-repo-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Alternative response with repository permissions */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["team-repository"];
+ "application/json": components["schemas"]["team-repository"];
};
};
/** @description Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Not Found if team does not have permission for the repository */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/add-or-update-repo-permissions-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/add-or-update-repo-permissions-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. */
- readonly permission?: string;
+ permission?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/remove-repo-in-org": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "teams/remove-repo-in-org": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "teams/list-child-in-org": {
- readonly parameters: {
- readonly query?: {
+ "teams/list-child-in-org": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The slug of the team name. */
- readonly team_slug: components["parameters"]["team-slug"];
+ team_slug: components["parameters"]["team-slug"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description if child teams exist */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["team"][];
};
};
};
};
- readonly "orgs/enable-or-disable-security-product-on-all-org-repos": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "orgs/enable-or-disable-security-product-on-all-org-repos": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The organization name. The name is not case sensitive. */
- readonly org: components["parameters"]["org"];
+ org: components["parameters"]["org"];
/** @description The security feature to enable or disable. */
- readonly security_product: components["parameters"]["security-product"];
+ security_product: components["parameters"]["security-product"];
/**
* @description The action to take.
*
* `enable_all` means to enable the specified security feature for all repositories in the organization.
* `disable_all` means to disable the specified security feature for all repositories in the organization.
*/
- readonly enablement: components["parameters"]["org-security-product-enablement"];
+ enablement: components["parameters"]["org-security-product-enablement"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description CodeQL query suite to be used. If you specify the `query_suite` parameter, the default setup will be configured with this query suite only on all repositories that didn't have default setup already configured. It will not change the query suite on repositories that already have default setup configured.
* If you don't specify any `query_suite` in your request, the preferred query suite of the organization will be applied.
* @enum {string}
*/
- readonly query_suite?: "default" | "extended";
+ query_suite?: "default" | "extended";
};
};
};
- readonly responses: {
+ responses: {
/** @description Action started */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description The action could not be taken due to an in progress enablement, or a policy is preventing enablement */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "projects/get-card": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the card. */
- readonly card_id: components["parameters"]["card-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-card"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- };
- };
- readonly "projects/delete-card": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the card. */
- readonly card_id: components["parameters"]["card-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- /** @description Forbidden */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly string[];
- };
- };
- };
- readonly 404: components["responses"]["not_found"];
- };
- };
- readonly "projects/update-card": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the card. */
- readonly card_id: components["parameters"]["card-id"];
- };
- readonly cookie?: never;
+ "rate-limit/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The project card's note
- * @example Update all gems
- */
- readonly note?: string | null;
- /**
- * @description Whether or not the card is archived
- * @example false
- */
- readonly archived?: boolean;
- };
- };
- };
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"];
+ "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"];
+ "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["project-card"];
+ "application/json": components["schemas"]["rate-limit-overview"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "projects/move-card": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the card. */
- readonly card_id: components["parameters"]["card-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.
- * @example bottom
- */
- readonly position: string;
- /**
- * @description The unique identifier of the column the card should be moved to
- * @example 42
- */
- readonly column_id?: number;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": Record;
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- /** @description Forbidden */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly {
- readonly code?: string;
- readonly message?: string;
- readonly resource?: string;
- readonly field?: string;
- }[];
- };
- };
- };
- readonly 422: components["responses"]["validation_failed"];
- /** @description Response */
- readonly 503: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly code?: string;
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly {
- readonly code?: string;
- readonly message?: string;
- }[];
- };
- };
- };
- };
- };
- readonly "projects/get-column": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-column"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- };
- };
- readonly "projects/delete-column": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- };
- };
- readonly "projects/update-column": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
- readonly name: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-column"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- };
- };
- readonly "projects/list-cards": {
- readonly parameters: {
- readonly query?: {
- /** @description Filters the project cards that are returned by the card's state. */
- readonly archived_state?: "all" | "archived" | "not_archived";
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["project-card"][];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- };
- };
- readonly "projects/create-card": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The project card's note
- * @example Update all gems
- */
- readonly note: string | null;
- } | {
- /**
- * @description The unique identifier of the content associated with the card
- * @example 42
- */
- readonly content_id: number;
- /**
- * @description The piece of content associated with the card
- * @example PullRequest
- */
- readonly content_type: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-card"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- /** @description Validation failed */
- readonly 422: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["validation-error-simple"];
- };
- };
- /** @description Response */
- readonly 503: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly code?: string;
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly {
- readonly code?: string;
- readonly message?: string;
- }[];
- };
- };
- };
- };
- };
- readonly "projects/move-column": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the column. */
- readonly column_id: components["parameters"]["column-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.
- * @example last
- */
- readonly position: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": Record;
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed_simple"];
- };
- };
- readonly "projects/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- };
- };
- readonly "projects/delete": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Delete Success */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- /** @description Forbidden */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly string[];
- };
- };
- };
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- };
- };
- readonly "projects/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description Name of the project
- * @example Week One Sprint
- */
- readonly name?: string;
- /**
- * @description Body of the project
- * @example This project represents the sprint of the first week in January
- */
- readonly body?: string | null;
- /**
- * @description State of the project; either 'open' or 'closed'
- * @example open
- */
- readonly state?: string;
- /**
- * @description The baseline permission that all organization members have on this project
- * @enum {string}
- */
- readonly organization_permission?: "read" | "write" | "admin" | "none";
- /** @description Whether or not this project can be seen by everyone. */
- readonly private?: boolean;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- /** @description Forbidden */
- readonly 403: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
- readonly errors?: readonly string[];
- };
- };
- };
- /** @description Not Found if the authenticated user does not have access to the project */
- readonly 404: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed_simple"];
- };
- };
- readonly "projects/list-collaborators": {
- readonly parameters: {
- readonly query?: {
- /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
- readonly affiliation?: "outside" | "direct" | "all";
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- };
- };
- readonly "projects/add-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- /** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description The permission to grant the collaborator.
- * @default write
- * @example write
- * @enum {string}
- */
- readonly permission?: "read" | "write" | "admin";
- } | null;
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- };
- };
- readonly "projects/remove-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- /** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 204: {
- headers: {
- readonly [name: string]: unknown;
- };
- content?: never;
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- };
- };
- readonly "projects/get-permission-for-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- /** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-collaborator-permission"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- };
- };
- readonly "projects/list-columns": {
- readonly parameters: {
- readonly query?: {
- /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
- /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- };
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": readonly components["schemas"]["project-column"][];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- };
- };
- readonly "projects/create-column": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
- /** @description The unique identifier of the project. */
- readonly project_id: components["parameters"]["project-id"];
- };
- readonly cookie?: never;
- };
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /**
- * @description Name of the project column
- * @example Remaining tasks
- */
- readonly name: string;
- };
- };
- };
- readonly responses: {
- /** @description Response */
- readonly 201: {
- headers: {
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["project-column"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed_simple"];
- };
- };
- readonly "rate-limit/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path?: never;
- readonly cookie?: never;
- };
- readonly requestBody?: never;
- readonly responses: {
- /** @description Response */
- readonly 200: {
- headers: {
- readonly "X-RateLimit-Limit": components["headers"]["x-rate-limit-limit"];
- readonly "X-RateLimit-Remaining": components["headers"]["x-rate-limit-remaining"];
- readonly "X-RateLimit-Reset": components["headers"]["x-rate-limit-reset"];
- readonly [name: string]: unknown;
- };
- content: {
- readonly "application/json": components["schemas"]["rate-limit-overview"];
- };
- };
- readonly 304: components["responses"]["not_modified"];
- readonly 404: components["responses"]["not_found"];
- };
- };
- readonly "repos/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["full-repository"];
+ "application/json": components["schemas"]["full-repository"];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 301: components["responses"]["moved_permanently"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 307: components["responses"]["temporary_redirect"];
+ 307: components["responses"]["temporary_redirect"];
/** @description If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response: */
- readonly 403: {
+ 403: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly message?: string;
- readonly documentation_url?: string;
+ "application/json": {
+ message?: string;
+ documentation_url?: string;
};
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "repos/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The name of the repository. */
- readonly name?: string;
+ name?: string;
/** @description A short description of the repository. */
- readonly description?: string;
+ description?: string;
/** @description A URL with more information about the repository. */
- readonly homepage?: string;
+ homepage?: string;
/**
* @description Either `true` to make the repository private or `false` to make it public. Default: `false`.
* **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.
* @default false
*/
- readonly private?: boolean;
+ private?: boolean;
/**
* @description The visibility of the repository.
* @enum {string}
*/
- readonly visibility?: "public" | "private";
+ visibility?: "public" | "private";
/**
* @description Specify which security and analysis features to enable or disable for the repository.
*
@@ -101356,91 +108461,132 @@ export interface operations {
*
* You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.
*/
- readonly security_and_analysis?: {
- /** @description Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)." */
- readonly advanced_security?: {
+ security_and_analysis?: {
+ /**
+ * @description Use the `status` property to enable or disable GitHub Advanced Security for this repository.
+ * For more information, see "[About GitHub Advanced
+ * Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)."
+ *
+ * For standalone Code Scanning or Secret Protection products, this parameter cannot be used.
+ */
+ advanced_security?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ /** @description Use the `status` property to enable or disable GitHub Code Security for this repository. */
+ code_security?: {
/** @description Can be `enabled` or `disabled`. */
- readonly status?: string;
+ status?: string;
};
/** @description Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)." */
- readonly secret_scanning?: {
+ secret_scanning?: {
/** @description Can be `enabled` or `disabled`. */
- readonly status?: string;
+ status?: string;
};
/** @description Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." */
- readonly secret_scanning_push_protection?: {
+ secret_scanning_push_protection?: {
/** @description Can be `enabled` or `disabled`. */
- readonly status?: string;
+ status?: string;
};
/** @description Use the `status` property to enable or disable secret scanning AI detection for this repository. For more information, see "[Responsible detection of generic secrets with AI](https://docs.github.com/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/generic-secret-detection/responsible-ai-generic-secrets)." */
- readonly secret_scanning_ai_detection?: {
+ secret_scanning_ai_detection?: {
/** @description Can be `enabled` or `disabled`. */
- readonly status?: string;
+ status?: string;
};
/** @description Use the `status` property to enable or disable secret scanning non-provider patterns for this repository. For more information, see "[Supported secret scanning patterns](/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." */
- readonly secret_scanning_non_provider_patterns?: {
+ secret_scanning_non_provider_patterns?: {
/** @description Can be `enabled` or `disabled`. */
- readonly status?: string;
+ status?: string;
+ };
+ /** @description Use the `status` property to enable or disable secret scanning delegated alert dismissal for this repository. */
+ secret_scanning_delegated_alert_dismissal?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ /** @description Use the `status` property to enable or disable secret scanning delegated bypass for this repository. */
+ secret_scanning_delegated_bypass?: {
+ /** @description Can be `enabled` or `disabled`. */
+ status?: string;
+ };
+ /**
+ * @description Feature options for secret scanning delegated bypass.
+ * This object is only honored when `security_and_analysis.secret_scanning_delegated_bypass.status` is set to `enabled`.
+ * You can send this object in the same request as `secret_scanning_delegated_bypass`, or update just the options in a separate request.
+ */
+ secret_scanning_delegated_bypass_options?: {
+ /**
+ * @description The bypass reviewers for secret scanning delegated bypass.
+ * If you omit this field, the existing set of reviewers is unchanged.
+ */
+ reviewers?: {
+ /** @description The ID of the team or role selected as a bypass reviewer */
+ reviewer_id: number;
+ /**
+ * @description The type of the bypass reviewer
+ * @enum {string}
+ */
+ reviewer_type: "TEAM" | "ROLE";
+ }[];
};
} | null;
/**
* @description Either `true` to enable issues for this repository or `false` to disable them.
* @default true
*/
- readonly has_issues?: boolean;
+ has_issues?: boolean;
/**
* @description Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
* @default true
*/
- readonly has_projects?: boolean;
+ has_projects?: boolean;
/**
* @description Either `true` to enable the wiki for this repository or `false` to disable it.
* @default true
*/
- readonly has_wiki?: boolean;
+ has_wiki?: boolean;
/**
* @description Either `true` to make this repo available as a template repository or `false` to prevent it.
* @default false
*/
- readonly is_template?: boolean;
+ is_template?: boolean;
/** @description Updates the default branch for this repository. */
- readonly default_branch?: string;
+ default_branch?: string;
/**
* @description Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
* @default true
*/
- readonly allow_squash_merge?: boolean;
+ allow_squash_merge?: boolean;
/**
* @description Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
* @default true
*/
- readonly allow_merge_commit?: boolean;
+ allow_merge_commit?: boolean;
/**
* @description Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
* @default true
*/
- readonly allow_rebase_merge?: boolean;
+ allow_rebase_merge?: boolean;
/**
* @description Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.
* @default false
*/
- readonly allow_auto_merge?: boolean;
+ allow_auto_merge?: boolean;
/**
* @description Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.
* @default false
*/
- readonly delete_branch_on_merge?: boolean;
+ delete_branch_on_merge?: boolean;
/**
* @description Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
* @default false
*/
- readonly allow_update_branch?: boolean;
+ allow_update_branch?: boolean;
/**
* @deprecated
* @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property is closing down. Please use `squash_merge_commit_title` instead.
* @default false
*/
- readonly use_squash_pr_title_as_default?: boolean;
+ use_squash_pr_title_as_default?: boolean;
/**
* @description Required when using `squash_merge_commit_message`.
*
@@ -101450,7 +108596,7 @@ export interface operations {
* - `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}
*/
- readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
/**
* @description The default value for a squash merge commit message:
*
@@ -101459,7 +108605,7 @@ export interface operations {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
/**
* @description Required when using `merge_commit_message`.
*
@@ -101469,7 +108615,7 @@ export interface operations {
* - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
* @enum {string}
*/
- readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
+ merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE";
/**
* @description The default value for a merge commit message.
*
@@ -101478,1555 +108624,1838 @@ export interface operations {
* - `BLANK` - default to a blank commit message.
* @enum {string}
*/
- readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
+ merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK";
/**
* @description Whether to archive this repository. `false` will unarchive a previously archived repository.
* @default false
*/
- readonly archived?: boolean;
+ archived?: boolean;
/**
* @description Either `true` to allow private forks, or `false` to prevent private forks.
* @default false
*/
- readonly allow_forking?: boolean;
+ allow_forking?: boolean;
/**
* @description Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.
* @default false
*/
- readonly web_commit_signoff_required?: boolean;
+ web_commit_signoff_required?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["full-repository"];
+ "application/json": components["schemas"]["full-repository"];
};
};
- readonly 307: components["responses"]["temporary_redirect"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 307: components["responses"]["temporary_redirect"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "actions/list-artifacts-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-artifacts-for-repo": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
- readonly name?: components["parameters"]["artifact-name"];
+ name?: components["parameters"]["artifact-name"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly artifacts: readonly components["schemas"]["artifact"][];
+ "application/json": {
+ total_count: number;
+ artifacts: components["schemas"]["artifact"][];
};
};
};
};
};
- readonly "actions/get-artifact": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-artifact": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the artifact. */
- readonly artifact_id: components["parameters"]["artifact-id"];
+ artifact_id: components["parameters"]["artifact-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["artifact"];
+ "application/json": components["schemas"]["artifact"];
};
};
};
};
- readonly "actions/delete-artifact": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-artifact": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the artifact. */
- readonly artifact_id: components["parameters"]["artifact-id"];
+ artifact_id: components["parameters"]["artifact-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/download-artifact": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/download-artifact": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the artifact. */
- readonly artifact_id: components["parameters"]["artifact-id"];
- readonly archive_format: string;
+ artifact_id: components["parameters"]["artifact-id"];
+ archive_format: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 302: {
+ 302: {
headers: {
- readonly Location: components["headers"]["location"];
- readonly [name: string]: unknown;
+ Location: components["headers"]["location"];
+ [name: string]: unknown;
};
content?: never;
};
- readonly 410: components["responses"]["gone"];
+ 410: components["responses"]["gone"];
};
};
- readonly "actions/get-actions-cache-usage": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-actions-cache-retention-limit-for-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-cache-usage-by-repository"];
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-actions-cache-retention-limit-for-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-retention-limit-for-repository"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/get-actions-cache-list": {
- readonly parameters: {
- readonly query?: {
+ "actions/get-actions-cache-storage-limit-for-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"];
+ };
+ };
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-actions-cache-storage-limit-for-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-cache-storage-limit-for-repository"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/get-actions-cache-usage": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-cache-usage-by-repository"];
+ };
+ };
+ };
+ };
+ "actions/get-actions-cache-list": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */
- readonly ref?: components["parameters"]["actions-cache-git-ref-full"];
+ ref?: components["parameters"]["actions-cache-git-ref-full"];
/** @description An explicit key or prefix for identifying the cache */
- readonly key?: components["parameters"]["actions-cache-key"];
+ key?: components["parameters"]["actions-cache-key"];
/** @description The property to sort the results by. `created_at` means when the cache was created. `last_accessed_at` means when the cache was last accessed. `size_in_bytes` is the size of the cache in bytes. */
- readonly sort?: components["parameters"]["actions-cache-list-sort"];
+ sort?: components["parameters"]["actions-cache-list-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-cache-list"];
+ "application/json": components["schemas"]["actions-cache-list"];
};
};
};
};
- readonly "actions/delete-actions-cache-by-key": {
- readonly parameters: {
- readonly query: {
+ "actions/delete-actions-cache-by-key": {
+ parameters: {
+ query: {
/** @description A key for identifying the cache. */
- readonly key: components["parameters"]["actions-cache-key-required"];
+ key: components["parameters"]["actions-cache-key-required"];
/** @description The full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */
- readonly ref?: components["parameters"]["actions-cache-git-ref-full"];
+ ref?: components["parameters"]["actions-cache-git-ref-full"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-cache-list"];
+ "application/json": components["schemas"]["actions-cache-list"];
};
};
};
};
- readonly "actions/delete-actions-cache-by-id": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-actions-cache-by-id": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the GitHub Actions cache. */
- readonly cache_id: components["parameters"]["cache-id"];
+ cache_id: components["parameters"]["cache-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/get-job-for-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-job-for-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the job. */
- readonly job_id: components["parameters"]["job-id"];
+ job_id: components["parameters"]["job-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["job"];
+ "application/json": components["schemas"]["job"];
};
};
};
};
- readonly "actions/download-job-logs-for-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/download-job-logs-for-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the job. */
- readonly job_id: components["parameters"]["job-id"];
+ job_id: components["parameters"]["job-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 302: {
+ 302: {
headers: {
/** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/re-run-job-for-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/re-run-job-for-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the job. */
- readonly job_id: components["parameters"]["job-id"];
+ job_id: components["parameters"]["job-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description Whether to enable debug logging for the re-run.
* @default false
*/
- readonly enable_debug_logging?: boolean;
+ enable_debug_logging?: boolean;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- readonly 403: components["responses"]["forbidden"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "actions/get-custom-oidc-sub-claim-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-custom-oidc-sub-claim-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Status response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["oidc-custom-sub-repo"];
+ "application/json": components["schemas"]["oidc-custom-sub-repo"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-custom-oidc-sub-claim-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-custom-oidc-sub-claim-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Whether to use the default template or not. If `true`, the `include_claim_keys` field is ignored. */
- readonly use_default: boolean;
+ use_default: boolean;
/** @description Array of unique strings. Each claim key can only contain alphanumeric characters and underscores. */
- readonly include_claim_keys?: readonly string[];
+ include_claim_keys?: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Empty response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/list-repo-organization-secrets": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-organization-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["actions-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["actions-secret"][];
};
};
};
};
};
- readonly "actions/list-repo-organization-variables": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-organization-variables": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["variables-per-page"];
+ per_page?: components["parameters"]["variables-per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly variables: readonly components["schemas"]["actions-variable"][];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
};
};
};
};
};
- readonly "actions/get-github-actions-permissions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-github-actions-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-repository-permissions"];
+ };
+ };
+ };
+ };
+ "actions/set-github-actions-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody: {
+ content: {
+ "application/json": {
+ enabled: components["schemas"]["actions-enabled"];
+ allowed_actions?: components["schemas"]["allowed-actions"];
+ sha_pinning_required?: components["schemas"]["sha-pinning-required"];
+ };
+ };
+ };
+ responses: {
/** @description Response */
- readonly 200: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "actions/get-workflow-access-to-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-repository-permissions"];
+ "application/json": components["schemas"]["actions-workflow-access-to-repository"];
};
};
};
};
- readonly "actions/set-github-actions-permissions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-workflow-access-to-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly enabled: components["schemas"]["actions-enabled"];
- readonly allowed_actions?: components["schemas"]["allowed-actions"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
+ content?: never;
+ };
+ };
+ };
+ "actions/get-artifact-and-log-retention-settings-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
};
+ cookie?: never;
};
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["actions-artifact-and-log-retention-response"];
+ };
+ };
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "actions/set-artifact-and-log-retention-settings-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-artifact-and-log-retention"];
+ };
+ };
+ responses: {
+ /** @description Empty response for successful settings update */
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "actions/get-workflow-access-to-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-fork-pr-contributor-approval-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ "application/json": components["schemas"]["actions-fork-pr-contributor-approval"];
};
};
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-workflow-access-to-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-fork-pr-contributor-approval-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["actions-workflow-access-to-repository"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-contributor-approval"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "actions/get-allowed-actions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-private-repo-fork-pr-workflows-settings-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["selected-actions"];
+ "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos"];
};
};
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-allowed-actions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-private-repo-fork-pr-workflows-settings-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": components["schemas"]["selected-actions"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-fork-pr-workflows-private-repos-request"];
};
};
- readonly responses: {
+ responses: {
+ /** @description Empty response for successful settings update */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "actions/get-allowed-actions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["selected-actions"];
+ };
+ };
+ };
+ };
+ "actions/set-allowed-actions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["selected-actions"];
+ };
+ };
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/get-github-actions-default-workflow-permissions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-github-actions-default-workflow-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
+ "application/json": components["schemas"]["actions-get-default-workflow-permissions"];
};
};
};
};
- readonly "actions/set-github-actions-default-workflow-permissions-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-github-actions-default-workflow-permissions-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["actions-set-default-workflow-permissions"];
};
};
- readonly responses: {
+ responses: {
/** @description Success response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Conflict response when changing a setting is prevented by the owning organization */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-self-hosted-runners-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-self-hosted-runners-for-repo": {
+ parameters: {
+ query?: {
/** @description The name of a self-hosted runner. */
- readonly name?: string;
+ name?: string;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly runners: readonly components["schemas"]["runner"][];
+ "application/json": {
+ total_count: number;
+ runners: components["schemas"]["runner"][];
};
};
};
};
};
- readonly "actions/list-runner-applications-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/list-runner-applications-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["runner-application"][];
+ "application/json": components["schemas"]["runner-application"][];
};
};
};
};
- readonly "actions/generate-runner-jitconfig-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/generate-runner-jitconfig-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the new runner. */
- readonly name: string;
+ name: string;
/** @description The ID of the runner group to register the runner to. */
- readonly runner_group_id: number;
+ runner_group_id: number;
/** @description The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100. */
- readonly labels: readonly string[];
+ labels: string[];
/**
* @description The working directory to be used for job execution, relative to the runner install directory.
* @default _work
*/
- readonly work_folder?: string;
+ work_folder?: string;
};
};
};
- readonly responses: {
- readonly 201: components["responses"]["actions_runner_jitconfig"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 201: components["responses"]["actions_runner_jitconfig"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/create-registration-token-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-registration-token-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- readonly "actions/create-remove-token-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-remove-token-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["authentication-token"];
+ "application/json": components["schemas"]["authentication-token"];
};
};
};
};
- readonly "actions/get-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["runner"];
+ "application/json": components["schemas"]["runner"];
};
};
};
};
- readonly "actions/delete-self-hosted-runner-from-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-self-hosted-runner-from-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/list-labels-for-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/list-labels-for-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/set-custom-labels-for-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/set-custom-labels-for-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of the custom labels to set for the runner. You can pass an empty array to remove all custom labels. */
- readonly labels: readonly string[];
+ labels: string[];
};
};
};
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/add-custom-labels-to-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/add-custom-labels-to-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The names of the custom labels to add to the runner. */
- readonly labels: readonly string[];
+ labels: string[];
};
};
};
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-all-custom-labels-from-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels_readonly"];
- readonly 404: components["responses"]["not_found"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels_readonly"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/remove-custom-label-from-self-hosted-runner-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/remove-custom-label-from-self-hosted-runner-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description Unique identifier of the self-hosted runner. */
- readonly runner_id: components["parameters"]["runner-id"];
+ runner_id: components["parameters"]["runner-id"];
/** @description The name of a self-hosted runner's custom label. */
- readonly name: components["parameters"]["runner-label-name"];
+ name: components["parameters"]["runner-label-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 200: components["responses"]["actions_runner_labels"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ requestBody?: never;
+ responses: {
+ 200: components["responses"]["actions_runner_labels"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "actions/list-workflow-runs-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-workflow-runs-for-repo": {
+ parameters: {
+ query?: {
/** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- readonly actor?: components["parameters"]["actor"];
+ actor?: components["parameters"]["actor"];
/** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- readonly branch?: components["parameters"]["workflow-run-branch"];
+ branch?: components["parameters"]["workflow-run-branch"];
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- readonly event?: components["parameters"]["event"];
+ event?: components["parameters"]["event"];
/** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
- readonly status?: components["parameters"]["workflow-run-status"];
+ status?: components["parameters"]["workflow-run-status"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- readonly created?: components["parameters"]["created"];
+ created?: components["parameters"]["created"];
/** @description If `true` pull requests are omitted from the response (empty array). */
- readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
/** @description Returns workflow runs with the `check_suite_id` that you specify. */
- readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
+ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
/** @description Only returns workflow runs that are associated with the specified `head_sha`. */
- readonly head_sha?: components["parameters"]["workflow-run-head-sha"];
+ head_sha?: components["parameters"]["workflow-run-head-sha"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly workflow_runs: readonly components["schemas"]["workflow-run"][];
+ "application/json": {
+ total_count: number;
+ workflow_runs: components["schemas"]["workflow-run"][];
};
};
};
};
};
- readonly "actions/get-workflow-run": {
- readonly parameters: {
- readonly query?: {
+ "actions/get-workflow-run": {
+ parameters: {
+ query?: {
/** @description If `true` pull requests are omitted from the response (empty array). */
- readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["workflow-run"];
+ "application/json": components["schemas"]["workflow-run"];
};
};
};
};
- readonly "actions/delete-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/get-reviews-for-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-reviews-for-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["environment-approvals"][];
+ "application/json": components["schemas"]["environment-approvals"][];
};
};
};
};
- readonly "actions/approve-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/approve-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/list-workflow-run-artifacts": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-workflow-run-artifacts": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The name field of an artifact. When specified, only artifacts with this name will be returned. */
- readonly name?: components["parameters"]["artifact-name"];
+ name?: components["parameters"]["artifact-name"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly artifacts: readonly components["schemas"]["artifact"][];
+ "application/json": {
+ total_count: number;
+ artifacts: components["schemas"]["artifact"][];
};
};
};
};
};
- readonly "actions/get-workflow-run-attempt": {
- readonly parameters: {
- readonly query?: {
+ "actions/get-workflow-run-attempt": {
+ parameters: {
+ query?: {
/** @description If `true` pull requests are omitted from the response (empty array). */
- readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
/** @description The attempt number of the workflow run. */
- readonly attempt_number: components["parameters"]["attempt-number"];
+ attempt_number: components["parameters"]["attempt-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["workflow-run"];
+ "application/json": components["schemas"]["workflow-run"];
};
};
};
};
- readonly "actions/list-jobs-for-workflow-run-attempt": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-jobs-for-workflow-run-attempt": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
/** @description The attempt number of the workflow run. */
- readonly attempt_number: components["parameters"]["attempt-number"];
+ attempt_number: components["parameters"]["attempt-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly jobs: readonly components["schemas"]["job"][];
+ "application/json": {
+ total_count: number;
+ jobs: components["schemas"]["job"][];
};
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "actions/download-workflow-run-attempt-logs": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/download-workflow-run-attempt-logs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
/** @description The attempt number of the workflow run. */
- readonly attempt_number: components["parameters"]["attempt-number"];
+ attempt_number: components["parameters"]["attempt-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 302: {
+ 302: {
headers: {
/** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/cancel-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/cancel-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- readonly 409: components["responses"]["conflict"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "actions/review-custom-gates-for-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/review-custom-gates-for-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["review-custom-gates-comment-required"] | components["schemas"]["review-custom-gates-state-required"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/force-cancel-workflow-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/force-cancel-workflow-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
- readonly 409: components["responses"]["conflict"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "actions/list-jobs-for-workflow-run": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-jobs-for-workflow-run": {
+ parameters: {
+ query?: {
/** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */
- readonly filter?: "latest" | "all";
+ filter?: "latest" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly jobs: readonly components["schemas"]["job"][];
+ "application/json": {
+ total_count: number;
+ jobs: components["schemas"]["job"][];
};
};
};
};
};
- readonly "actions/download-workflow-run-logs": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/download-workflow-run-logs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 302: {
+ 302: {
headers: {
/** @example https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/delete-workflow-run-logs": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-workflow-run-logs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 500: components["responses"]["internal_error"];
+ 403: components["responses"]["forbidden"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "actions/get-pending-deployments-for-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-pending-deployments-for-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["pending-deployment"][];
+ "application/json": components["schemas"]["pending-deployment"][];
};
};
};
};
- readonly "actions/review-pending-deployments-for-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/review-pending-deployments-for-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The list of environment ids to approve or reject
* @example [
@@ -103034,4199 +110463,4227 @@ export interface operations {
* 161171795
* ]
*/
- readonly environment_ids: readonly number[];
+ environment_ids: number[];
/**
* @description Whether to approve or reject deployment to the specified environments.
* @example approved
* @enum {string}
*/
- readonly state: "approved" | "rejected";
+ state: "approved" | "rejected";
/**
* @description A comment to accompany the deployment review
* @example Ship it!
*/
- readonly comment: string;
+ comment: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["deployment"][];
+ "application/json": components["schemas"]["deployment"][];
};
};
};
};
- readonly "actions/re-run-workflow": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/re-run-workflow": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description Whether to enable debug logging for the re-run.
* @default false
*/
- readonly enable_debug_logging?: boolean;
+ enable_debug_logging?: boolean;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "actions/re-run-workflow-failed-jobs": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/re-run-workflow-failed-jobs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description Whether to enable debug logging for the re-run.
* @default false
*/
- readonly enable_debug_logging?: boolean;
+ enable_debug_logging?: boolean;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "actions/get-workflow-run-usage": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-workflow-run-usage": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the workflow run. */
- readonly run_id: components["parameters"]["run-id"];
+ run_id: components["parameters"]["run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["workflow-run-usage"];
+ "application/json": components["schemas"]["workflow-run-usage"];
};
};
};
};
- readonly "actions/list-repo-secrets": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["actions-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["actions-secret"][];
};
};
};
};
};
- readonly "actions/get-repo-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-repo-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-public-key"];
+ "application/json": components["schemas"]["actions-public-key"];
};
};
};
};
- readonly "actions/get-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-secret"];
+ "application/json": components["schemas"]["actions-secret"];
};
};
};
};
- readonly "actions/create-or-update-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-or-update-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/actions/secrets#get-a-repository-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/delete-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-repo-variables": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-variables": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["variables-per-page"];
+ per_page?: components["parameters"]["variables-per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly variables: readonly components["schemas"]["actions-variable"][];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
};
};
};
};
};
- readonly "actions/create-repo-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-repo-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name: string;
+ name: string;
/** @description The value of the variable. */
- readonly value: string;
+ value: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "actions/get-repo-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-repo-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-variable"];
+ "application/json": components["schemas"]["actions-variable"];
};
};
};
};
- readonly "actions/delete-repo-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-repo-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/update-repo-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/update-repo-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name?: string;
+ name?: string;
/** @description The value of the variable. */
- readonly value?: string;
+ value?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-repo-workflows": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-repo-workflows": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly workflows: readonly components["schemas"]["workflow"][];
+ "application/json": {
+ total_count: number;
+ workflows: components["schemas"]["workflow"][];
};
};
};
};
};
- readonly "actions/get-workflow": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-workflow": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["workflow"];
+ "application/json": components["schemas"]["workflow"];
};
};
};
};
- readonly "actions/disable-workflow": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/disable-workflow": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/create-workflow-dispatch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-workflow-dispatch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The git reference for the workflow. The reference can be a branch or tag name. */
- readonly ref: string;
- /** @description Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted. */
- readonly inputs?: {
- readonly [key: string]: unknown;
+ ref: string;
+ /** @description Input keys and values configured in the workflow file. The maximum number of properties is 25. Any default properties configured in the workflow file will be used when `inputs` are omitted. */
+ inputs?: {
+ [key: string]: unknown;
};
+ /** @description Whether the response should include the workflow run ID and URLs. */
+ return_run_details?: boolean;
};
};
};
- readonly responses: {
- /** @description Response */
- readonly 204: {
+ responses: {
+ /** @description Response including the workflow run ID and URLs when `return_run_details` parameter is `true`. */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["workflow-dispatch-response"];
+ };
+ };
+ /** @description Empty response when `return_run_details` parameter is `false`. */
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/enable-workflow": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/enable-workflow": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-workflow-runs": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-workflow-runs": {
+ parameters: {
+ query?: {
/** @description Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run. */
- readonly actor?: components["parameters"]["actor"];
+ actor?: components["parameters"]["actor"];
/** @description Returns workflow runs associated with a branch. Use the name of the branch of the `push`. */
- readonly branch?: components["parameters"]["workflow-run-branch"];
+ branch?: components["parameters"]["workflow-run-branch"];
/** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */
- readonly event?: components["parameters"]["event"];
+ event?: components["parameters"]["event"];
/** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */
- readonly status?: components["parameters"]["workflow-run-status"];
+ status?: components["parameters"]["workflow-run-status"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */
- readonly created?: components["parameters"]["created"];
+ created?: components["parameters"]["created"];
/** @description If `true` pull requests are omitted from the response (empty array). */
- readonly exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
+ exclude_pull_requests?: components["parameters"]["exclude-pull-requests"];
/** @description Returns workflow runs with the `check_suite_id` that you specify. */
- readonly check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
+ check_suite_id?: components["parameters"]["workflow-run-check-suite-id"];
/** @description Only returns workflow runs that are associated with the specified `head_sha`. */
- readonly head_sha?: components["parameters"]["workflow-run-head-sha"];
+ head_sha?: components["parameters"]["workflow-run-head-sha"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly workflow_runs: readonly components["schemas"]["workflow-run"][];
+ "application/json": {
+ total_count: number;
+ workflow_runs: components["schemas"]["workflow-run"][];
};
};
};
};
};
- readonly "actions/get-workflow-usage": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-workflow-usage": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the workflow. You can also pass the workflow file name as a string. */
- readonly workflow_id: components["parameters"]["workflow-id"];
+ workflow_id: components["parameters"]["workflow-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["workflow-usage"];
+ "application/json": components["schemas"]["workflow-usage"];
};
};
};
};
- readonly "repos/list-activities": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-activities": {
+ parameters: {
+ query?: {
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/**
* @description The Git reference for the activities you want to list.
*
* The `ref` for a branch can be formatted either as `refs/heads/BRANCH_NAME` or `BRANCH_NAME`, where `BRANCH_NAME` is the name of your branch.
*/
- readonly ref?: string;
+ ref?: string;
/** @description The GitHub username to use to filter by the actor who performed the activity. */
- readonly actor?: string;
+ actor?: string;
/**
* @description The time period to filter by.
*
* For example, `day` will filter for activity that occurred in the past 24 hours, and `week` will filter for activity that occurred in the past 7 days (168 hours).
*/
- readonly time_period?: "day" | "week" | "month" | "quarter" | "year";
+ time_period?: "day" | "week" | "month" | "quarter" | "year";
/**
* @description The activity type to filter by.
*
* For example, you can choose to filter by "force_push", to see all force pushes to the repository.
*/
- readonly activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge";
+ activity_type?: "push" | "force_push" | "branch_creation" | "branch_deletion" | "pr_merge" | "merge_queue_merge";
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["activity"][];
+ "application/json": components["schemas"]["activity"][];
};
};
- readonly 422: components["responses"]["validation_failed_simple"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "issues/list-assignees": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-assignees": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "issues/check-user-can-be-assigned": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/check-user-can-be-assigned": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly assignee: string;
+ repo: components["parameters"]["repo"];
+ assignee: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Otherwise a `404` status code is returned. */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "repos/create-attestation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-attestation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The attestation's Sigstore Bundle.
* Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
*/
- readonly bundle: {
- readonly mediaType?: string;
- readonly verificationMaterial?: {
- readonly [key: string]: unknown;
+ bundle: {
+ mediaType?: string;
+ verificationMaterial?: {
+ [key: string]: unknown;
};
- readonly dsseEnvelope?: {
- readonly [key: string]: unknown;
+ dsseEnvelope?: {
+ [key: string]: unknown;
};
};
};
};
};
- readonly responses: {
+ responses: {
/** @description response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/** @description The ID of the attestation. */
- readonly id?: number;
+ id?: number;
};
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/list-attestations": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-attestations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
+ /**
+ * @description Optional filter for fetching attestations with a given predicate type.
+ * This option accepts `provenance`, `sbom`, `release`, or freeform text
+ * for custom predicate types.
+ */
+ predicate_type?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. */
- readonly subject_digest: string;
+ subject_digest: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly attestations?: readonly {
+ "application/json": {
+ attestations?: {
/**
* @description The attestation's Sigstore Bundle.
* Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information.
*/
- readonly bundle?: {
- readonly mediaType?: string;
- readonly verificationMaterial?: {
- readonly [key: string]: unknown;
+ bundle?: {
+ mediaType?: string;
+ verificationMaterial?: {
+ [key: string]: unknown;
};
- readonly dsseEnvelope?: {
- readonly [key: string]: unknown;
+ dsseEnvelope?: {
+ [key: string]: unknown;
};
};
- readonly repository_id?: number;
- readonly bundle_url?: string;
+ repository_id?: number;
+ bundle_url?: string;
+ initiator?: string;
}[];
};
};
};
};
};
- readonly "repos/list-autolinks": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/list-autolinks": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["autolink"][];
+ "application/json": components["schemas"]["autolink"][];
};
};
};
};
- readonly "repos/create-autolink": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-autolink": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. */
- readonly key_prefix: string;
+ key_prefix: string;
/** @description The URL must contain `` for the reference number. `` matches different characters depending on the value of `is_alphanumeric`. */
- readonly url_template: string;
+ url_template: string;
/**
* @description Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.
* @default true
*/
- readonly is_alphanumeric?: boolean;
+ is_alphanumeric?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/autolinks/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["autolink"];
+ "application/json": components["schemas"]["autolink"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-autolink": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-autolink": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the autolink. */
- readonly autolink_id: components["parameters"]["autolink-id"];
+ autolink_id: components["parameters"]["autolink-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["autolink"];
+ "application/json": components["schemas"]["autolink"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-autolink": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-autolink": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the autolink. */
- readonly autolink_id: components["parameters"]["autolink-id"];
+ autolink_id: components["parameters"]["autolink-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/check-automated-security-fixes": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/check-automated-security-fixes": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if Dependabot is enabled */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-automated-security-fixes"];
+ "application/json": components["schemas"]["check-automated-security-fixes"];
};
};
/** @description Not Found if Dependabot is not enabled for the repository */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/enable-automated-security-fixes": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/enable-automated-security-fixes": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/disable-automated-security-fixes": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/disable-automated-security-fixes": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-branches": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-branches": {
+ parameters: {
+ query?: {
/** @description Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */
- readonly protected?: boolean;
+ protected?: boolean;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["short-branch"][];
+ "application/json": components["schemas"]["short-branch"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/get-branch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-branch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["branch-with-protection"];
+ "application/json": components["schemas"]["branch-with-protection"];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/get-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["branch-protection"];
+ "application/json": components["schemas"]["branch-protection"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/update-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Require status checks to pass before merging. Set to `null` to disable. */
- readonly required_status_checks: {
+ required_status_checks: {
/** @description Require branches to be up to date before merging. */
- readonly strict: boolean;
+ strict: boolean;
/**
* @deprecated
* @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
*/
- readonly contexts: readonly string[];
+ contexts: string[];
/** @description The list of status checks to require in order to merge into this branch. */
- readonly checks?: readonly {
+ checks?: {
/** @description The name of the required check */
- readonly context: string;
+ context: string;
/** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
- readonly app_id?: number;
+ app_id?: number;
}[];
} | null;
/** @description Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable. */
- readonly enforce_admins: boolean | null;
+ enforce_admins: boolean | null;
/** @description Require at least one approving review on a pull request, before merging. Set to `null` to disable. */
- readonly required_pull_request_reviews: {
+ required_pull_request_reviews: {
/** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
- readonly dismissal_restrictions?: {
+ dismissal_restrictions?: {
/** @description The list of user `login`s with dismissal access */
- readonly users?: readonly string[];
+ users?: string[];
/** @description The list of team `slug`s with dismissal access */
- readonly teams?: readonly string[];
+ teams?: string[];
/** @description The list of app `slug`s with dismissal access */
- readonly apps?: readonly string[];
+ apps?: string[];
};
/** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
- readonly dismiss_stale_reviews?: boolean;
+ dismiss_stale_reviews?: boolean;
/** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them. */
- readonly require_code_owner_reviews?: boolean;
+ require_code_owner_reviews?: boolean;
/** @description Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
- readonly required_approving_review_count?: number;
+ required_approving_review_count?: number;
/**
* @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.
* @default false
*/
- readonly require_last_push_approval?: boolean;
+ require_last_push_approval?: boolean;
/** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- readonly bypass_pull_request_allowances?: {
+ bypass_pull_request_allowances?: {
/** @description The list of user `login`s allowed to bypass pull request requirements. */
- readonly users?: readonly string[];
+ users?: string[];
/** @description The list of team `slug`s allowed to bypass pull request requirements. */
- readonly teams?: readonly string[];
+ teams?: string[];
/** @description The list of app `slug`s allowed to bypass pull request requirements. */
- readonly apps?: readonly string[];
+ apps?: string[];
};
} | null;
/** @description Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable. */
- readonly restrictions: {
+ restrictions: {
/** @description The list of user `login`s with push access */
- readonly users: readonly string[];
+ users: string[];
/** @description The list of team `slug`s with push access */
- readonly teams: readonly string[];
+ teams: string[];
/** @description The list of app `slug`s with push access */
- readonly apps?: readonly string[];
+ apps?: string[];
} | null;
/** @description Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation. */
- readonly required_linear_history?: boolean;
+ required_linear_history?: boolean;
/** @description Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation." */
- readonly allow_force_pushes?: boolean | null;
+ allow_force_pushes?: boolean | null;
/** @description Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation. */
- readonly allow_deletions?: boolean;
+ allow_deletions?: boolean;
/** @description If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`. */
- readonly block_creations?: boolean;
+ block_creations?: boolean;
/** @description Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`. */
- readonly required_conversation_resolution?: boolean;
+ required_conversation_resolution?: boolean;
/**
* @description Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.
* @default false
*/
- readonly lock_branch?: boolean;
+ lock_branch?: boolean;
/**
* @description Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.
* @default false
*/
- readonly allow_fork_syncing?: boolean;
+ allow_fork_syncing?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch"];
+ "application/json": components["schemas"]["protected-branch"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "repos/delete-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
+ 403: components["responses"]["forbidden"];
};
};
- readonly "repos/get-admin-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-admin-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
};
};
- readonly "repos/set-admin-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/set-admin-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
};
};
- readonly "repos/delete-admin-branch-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-admin-branch-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/get-pull-request-review-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-pull-request-review-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-pull-request-review"];
+ "application/json": components["schemas"]["protected-branch-pull-request-review"];
};
};
};
};
- readonly "repos/delete-pull-request-review-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-pull-request-review-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/update-pull-request-review-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-pull-request-review-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories. */
- readonly dismissal_restrictions?: {
+ dismissal_restrictions?: {
/** @description The list of user `login`s with dismissal access */
- readonly users?: readonly string[];
+ users?: string[];
/** @description The list of team `slug`s with dismissal access */
- readonly teams?: readonly string[];
+ teams?: string[];
/** @description The list of app `slug`s with dismissal access */
- readonly apps?: readonly string[];
+ apps?: string[];
};
/** @description Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit. */
- readonly dismiss_stale_reviews?: boolean;
+ dismiss_stale_reviews?: boolean;
/** @description Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed. */
- readonly require_code_owner_reviews?: boolean;
+ require_code_owner_reviews?: boolean;
/** @description Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers. */
- readonly required_approving_review_count?: number;
+ required_approving_review_count?: number;
/**
* @description Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`
* @default false
*/
- readonly require_last_push_approval?: boolean;
+ require_last_push_approval?: boolean;
/** @description Allow specific users, teams, or apps to bypass pull request requirements. */
- readonly bypass_pull_request_allowances?: {
+ bypass_pull_request_allowances?: {
/** @description The list of user `login`s allowed to bypass pull request requirements. */
- readonly users?: readonly string[];
+ users?: string[];
/** @description The list of team `slug`s allowed to bypass pull request requirements. */
- readonly teams?: readonly string[];
+ teams?: string[];
/** @description The list of app `slug`s allowed to bypass pull request requirements. */
- readonly apps?: readonly string[];
+ apps?: string[];
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-pull-request-review"];
+ "application/json": components["schemas"]["protected-branch-pull-request-review"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-commit-signature-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-commit-signature-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/create-commit-signature-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-commit-signature-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["protected-branch-admin-enforced"];
+ "application/json": components["schemas"]["protected-branch-admin-enforced"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-commit-signature-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-commit-signature-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/get-status-checks-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-status-checks-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["status-check-policy"];
+ "application/json": components["schemas"]["status-check-policy"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/remove-status-check-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-status-check-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/update-status-check-protection": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-status-check-protection": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Require branches to be up to date before merging. */
- readonly strict?: boolean;
+ strict?: boolean;
/**
* @deprecated
* @description **Closing down notice**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
*/
- readonly contexts?: readonly string[];
+ contexts?: string[];
/** @description The list of status checks to require in order to merge into this branch. */
- readonly checks?: readonly {
+ checks?: {
/** @description The name of the required check */
- readonly context: string;
+ context: string;
/** @description The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status. */
- readonly app_id?: number;
+ app_id?: number;
}[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["status-check-policy"];
+ "application/json": components["schemas"]["status-check-policy"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-all-status-check-contexts": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-all-status-check-contexts": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly string[];
+ "application/json": string[];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/set-status-check-contexts": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/set-status-check-contexts": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The name of the status checks */
- readonly contexts: readonly string[];
- } | readonly string[];
+ contexts: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly string[];
+ "application/json": string[];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/add-status-check-contexts": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/add-status-check-contexts": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The name of the status checks */
- readonly contexts: readonly string[];
- } | readonly string[];
+ contexts: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly string[];
+ "application/json": string[];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/remove-status-check-contexts": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-status-check-contexts": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The name of the status checks */
- readonly contexts: readonly string[];
- } | readonly string[];
+ contexts: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly string[];
+ "application/json": string[];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["branch-restriction-policy"];
+ "application/json": components["schemas"]["branch-restriction-policy"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/get-apps-with-access-to-protected-branch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-apps-with-access-to-protected-branch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["integration"][];
+ "application/json": components["schemas"]["integration"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/set-app-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/set-app-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */
- readonly apps: readonly string[];
+ apps: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["integration"][];
+ "application/json": components["schemas"]["integration"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/add-app-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/add-app-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */
- readonly apps: readonly string[];
+ apps: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["integration"][];
+ "application/json": components["schemas"]["integration"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/remove-app-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-app-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The GitHub Apps that have push access to this branch. Use the slugified version of the app name. **Note**: The list of users, apps, and teams in total is limited to 100 items. */
- readonly apps: readonly string[];
+ apps: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["integration"][];
+ "application/json": components["schemas"]["integration"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-teams-with-access-to-protected-branch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-teams-with-access-to-protected-branch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["team"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/set-team-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/set-team-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The slug values for teams */
- readonly teams: readonly string[];
- } | readonly string[];
+ teams: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["team"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/add-team-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/add-team-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The slug values for teams */
- readonly teams: readonly string[];
- } | readonly string[];
+ teams: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["team"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/remove-team-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-team-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The slug values for teams */
- readonly teams: readonly string[];
- } | readonly string[];
+ teams: string[];
+ } | string[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["team"][];
+ "application/json": components["schemas"]["team"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-users-with-access-to-protected-branch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-users-with-access-to-protected-branch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/set-user-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/set-user-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The username for users */
- readonly users: readonly string[];
+ users: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/add-user-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/add-user-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The username for users */
- readonly users: readonly string[];
+ users: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/remove-user-access-restrictions": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-user-access-restrictions": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The username for users */
- readonly users: readonly string[];
+ users: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["simple-user"][];
+ "application/json": components["schemas"]["simple-user"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/rename-branch": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/rename-branch": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/graphql). */
- readonly branch: components["parameters"]["branch"];
+ branch: components["parameters"]["branch"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The new name of the branch. */
- readonly new_name: string;
+ new_name: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["branch-with-protection"];
+ "application/json": components["schemas"]["branch-with-protection"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "checks/create": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/create": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the check. For example, "code-coverage". */
- readonly name: string;
+ name: string;
/** @description The SHA of the commit. */
- readonly head_sha: string;
+ head_sha: string;
/** @description The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used. */
- readonly details_url?: string;
+ details_url?: string;
/** @description A reference for the run on the integrator's system. */
- readonly external_id?: string;
+ external_id?: string;
/**
* @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
* @default queued
* @enum {string}
*/
- readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* Format: date-time
* @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly started_at?: string;
+ started_at?: string;
/**
* @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
* **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
* @enum {string}
*/
- readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out";
+ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out";
/**
* Format: date-time
* @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly completed_at?: string;
+ completed_at?: string;
/** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */
- readonly output?: {
+ output?: {
/** @description The title of the check run. */
- readonly title: string;
+ title: string;
/** @description The summary of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */
- readonly summary: string;
+ summary: string;
/** @description The details of the check run. This parameter supports Markdown. **Maximum length**: 65535 characters. */
- readonly text?: string;
+ text?: string;
/** @description Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */
- readonly annotations?: readonly {
+ annotations?: {
/** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
- readonly path: string;
+ path: string;
/** @description The start line of the annotation. Line numbers start at 1. */
- readonly start_line: number;
+ start_line: number;
/** @description The end line of the annotation. */
- readonly end_line: number;
+ end_line: number;
/** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */
- readonly start_column?: number;
+ start_column?: number;
/** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- readonly end_column?: number;
+ end_column?: number;
/**
* @description The level of the annotation.
* @enum {string}
*/
- readonly annotation_level: "notice" | "warning" | "failure";
+ annotation_level: "notice" | "warning" | "failure";
/** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
- readonly message: string;
+ message: string;
/** @description The title that represents the annotation. The maximum size is 255 characters. */
- readonly title?: string;
+ title?: string;
/** @description Details about this annotation. The maximum size is 64 KB. */
- readonly raw_details?: string;
+ raw_details?: string;
}[];
/** @description Adds images to the output displayed in the GitHub pull request UI. */
- readonly images?: readonly {
+ images?: {
/** @description The alternative text for the image. */
- readonly alt: string;
+ alt: string;
/** @description The full URL of the image. */
- readonly image_url: string;
+ image_url: string;
/** @description A short image description. */
- readonly caption?: string;
+ caption?: string;
}[];
};
/** @description Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */
- readonly actions?: readonly {
+ actions?: {
/** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
- readonly label: string;
+ label: string;
/** @description A short explanation of what this action would do. The maximum size is 40 characters. */
- readonly description: string;
+ description: string;
/** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
- readonly identifier: string;
+ identifier: string;
}[];
} & (({
/** @enum {unknown} */
- readonly status: "completed";
+ status: "completed";
} & {
- readonly [key: string]: unknown;
+ [key: string]: unknown;
}) | ({
/** @enum {unknown} */
- readonly status?: "queued" | "in_progress";
+ status?: "queued" | "in_progress";
} & {
- readonly [key: string]: unknown;
+ [key: string]: unknown;
}));
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-run"];
+ "application/json": components["schemas"]["check-run"];
};
};
};
};
- readonly "checks/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check run. */
- readonly check_run_id: components["parameters"]["check-run-id"];
+ check_run_id: components["parameters"]["check-run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-run"];
+ "application/json": components["schemas"]["check-run"];
};
};
};
};
- readonly "checks/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check run. */
- readonly check_run_id: components["parameters"]["check-run-id"];
+ check_run_id: components["parameters"]["check-run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the check. For example, "code-coverage". */
- readonly name?: string;
+ name?: string;
/** @description The URL of the integrator's site that has the full details of the check. */
- readonly details_url?: string;
+ details_url?: string;
/** @description A reference for the run on the integrator's system. */
- readonly external_id?: string;
+ external_id?: string;
/**
* Format: date-time
* @description This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly started_at?: string;
+ started_at?: string;
/**
* @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.
* @enum {string}
*/
- readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
+ status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending";
/**
* @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
* **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.
* @enum {string}
*/
- readonly conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out";
+ conclusion?: "action_required" | "cancelled" | "failure" | "neutral" | "success" | "skipped" | "stale" | "timed_out";
/**
* Format: date-time
* @description The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly completed_at?: string;
+ completed_at?: string;
/** @description Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. */
- readonly output?: {
+ output?: {
/** @description **Required**. */
- readonly title?: string;
+ title?: string;
/** @description Can contain Markdown. */
- readonly summary: string;
+ summary: string;
/** @description Can contain Markdown. */
- readonly text?: string;
+ text?: string;
/** @description Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/articles/about-status-checks#checks)". */
- readonly annotations?: readonly {
+ annotations?: {
/** @description The path of the file to add an annotation to. For example, `assets/css/main.css`. */
- readonly path: string;
+ path: string;
/** @description The start line of the annotation. Line numbers start at 1. */
- readonly start_line: number;
+ start_line: number;
/** @description The end line of the annotation. */
- readonly end_line: number;
+ end_line: number;
/** @description The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1. */
- readonly start_column?: number;
+ start_column?: number;
/** @description The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. */
- readonly end_column?: number;
+ end_column?: number;
/**
* @description The level of the annotation.
* @enum {string}
*/
- readonly annotation_level: "notice" | "warning" | "failure";
+ annotation_level: "notice" | "warning" | "failure";
/** @description A short description of the feedback for these lines of code. The maximum size is 64 KB. */
- readonly message: string;
+ message: string;
/** @description The title that represents the annotation. The maximum size is 255 characters. */
- readonly title?: string;
+ title?: string;
/** @description Details about this annotation. The maximum size is 64 KB. */
- readonly raw_details?: string;
+ raw_details?: string;
}[];
/** @description Adds images to the output displayed in the GitHub pull request UI. */
- readonly images?: readonly {
+ images?: {
/** @description The alternative text for the image. */
- readonly alt: string;
+ alt: string;
/** @description The full URL of the image. */
- readonly image_url: string;
+ image_url: string;
/** @description A short image description. */
- readonly caption?: string;
+ caption?: string;
}[];
};
/** @description Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)." */
- readonly actions?: readonly {
+ actions?: {
/** @description The text to be displayed on a button in the web UI. The maximum size is 20 characters. */
- readonly label: string;
+ label: string;
/** @description A short explanation of what this action would do. The maximum size is 40 characters. */
- readonly description: string;
+ description: string;
/** @description A reference for the action on the integrator's system. The maximum size is 20 characters. */
- readonly identifier: string;
+ identifier: string;
}[];
} | ({
/** @enum {unknown} */
- readonly status?: "completed";
+ status?: "completed";
} & {
- readonly [key: string]: unknown;
+ [key: string]: unknown;
}) | ({
/** @enum {unknown} */
- readonly status?: "queued" | "in_progress";
+ status?: "queued" | "in_progress";
} & {
- readonly [key: string]: unknown;
+ [key: string]: unknown;
});
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-run"];
+ "application/json": components["schemas"]["check-run"];
};
};
};
};
- readonly "checks/list-annotations": {
- readonly parameters: {
- readonly query?: {
+ "checks/list-annotations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check run. */
- readonly check_run_id: components["parameters"]["check-run-id"];
+ check_run_id: components["parameters"]["check-run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["check-annotation"][];
+ "application/json": components["schemas"]["check-annotation"][];
};
};
};
};
- readonly "checks/rerequest-run": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/rerequest-run": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check run. */
- readonly check_run_id: components["parameters"]["check-run-id"];
+ check_run_id: components["parameters"]["check-run-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App */
- readonly 403: {
+ 403: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Validation error if the check run is not rerequestable */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "checks/create-suite": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/create-suite": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The sha of the head commit. */
- readonly head_sha: string;
+ head_sha: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when the suite already exists */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-suite"];
+ "application/json": components["schemas"]["check-suite"];
};
};
/** @description Response when the suite was created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-suite"];
+ "application/json": components["schemas"]["check-suite"];
};
};
};
};
- readonly "checks/set-suites-preferences": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/set-suites-preferences": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. */
- readonly auto_trigger_checks?: readonly {
+ auto_trigger_checks?: {
/** @description The `id` of the GitHub App. */
- readonly app_id: number;
+ app_id: number;
/**
* @description Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.
* @default true
*/
- readonly setting: boolean;
+ setting: boolean;
}[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-suite-preference"];
+ "application/json": components["schemas"]["check-suite-preference"];
};
};
};
};
- readonly "checks/get-suite": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/get-suite": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check suite. */
- readonly check_suite_id: components["parameters"]["check-suite-id"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["check-suite"];
+ "application/json": components["schemas"]["check-suite"];
};
};
};
};
- readonly "checks/list-for-suite": {
- readonly parameters: {
- readonly query?: {
+ "checks/list-for-suite": {
+ parameters: {
+ query?: {
/** @description Returns check runs with the specified `name`. */
- readonly check_name?: components["parameters"]["check-name"];
+ check_name?: components["parameters"]["check-name"];
/** @description Returns check runs with the specified `status`. */
- readonly status?: components["parameters"]["status"];
+ status?: components["parameters"]["status"];
/** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
- readonly filter?: "latest" | "all";
+ filter?: "latest" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check suite. */
- readonly check_suite_id: components["parameters"]["check-suite-id"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly check_runs: readonly components["schemas"]["check-run"][];
+ "application/json": {
+ total_count: number;
+ check_runs: components["schemas"]["check-run"][];
};
};
};
};
};
- readonly "checks/rerequest-suite": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "checks/rerequest-suite": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the check suite. */
- readonly check_suite_id: components["parameters"]["check-suite-id"];
+ check_suite_id: components["parameters"]["check-suite-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "code-scanning/list-alerts-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "code-scanning/list-alerts-for-repo": {
+ parameters: {
+ query?: {
/** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- readonly tool_name?: components["parameters"]["tool-name"];
+ tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- readonly tool_guid?: components["parameters"]["tool-guid"];
+ tool_guid?: components["parameters"]["tool-guid"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- readonly ref?: components["parameters"]["git-ref"];
+ ref?: components["parameters"]["git-ref"];
/** @description The number of the pull request for the results you want to list. */
- readonly pr?: components["parameters"]["pr-alias"];
+ pr?: components["parameters"]["pr-alias"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
+ after?: components["parameters"]["pagination-after"];
/** @description The property by which to sort the results. */
- readonly sort?: "created" | "updated";
+ sort?: "created" | "updated";
/** @description If specified, only code scanning alerts with this state will be returned. */
- readonly state?: components["schemas"]["code-scanning-alert-state-query"];
+ state?: components["schemas"]["code-scanning-alert-state-query"];
/** @description If specified, only code scanning alerts with this severity will be returned. */
- readonly severity?: components["schemas"]["code-scanning-alert-severity"];
+ severity?: components["schemas"]["code-scanning-alert-severity"];
+ /**
+ * @description Filter alerts by assignees. Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`).
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ assignees?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-scanning-alert-items"][];
+ "application/json": components["schemas"]["code-scanning-alert-items"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-alert": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-alert": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-alert"];
+ "application/json": components["schemas"]["code-scanning-alert"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/update-alert": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/update-alert": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly state: components["schemas"]["code-scanning-alert-set-state"];
- readonly dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"];
- readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
- };
+ requestBody: {
+ content: {
+ "application/json": {
+ state?: components["schemas"]["code-scanning-alert-set-state"];
+ dismissed_reason?: components["schemas"]["code-scanning-alert-dismissed-reason"];
+ dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"];
+ create_request?: components["schemas"]["code-scanning-alert-create-request"];
+ assignees?: components["schemas"]["code-scanning-alert-assignees"];
+ } | unknown | unknown;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-alert"];
+ "application/json": components["schemas"]["code-scanning-alert"];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-autofix": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-autofix": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-autofix"];
+ "application/json": components["schemas"]["code-scanning-autofix"];
};
};
- readonly 400: components["responses"]["code_scanning_bad_request"];
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["code_scanning_bad_request"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/create-autofix": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/create-autofix": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description OK */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-autofix"];
+ "application/json": components["schemas"]["code-scanning-autofix"];
};
};
/** @description Accepted */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-autofix"];
+ "application/json": components["schemas"]["code-scanning-autofix"];
};
};
- readonly 400: components["responses"]["code_scanning_bad_request"];
- readonly 403: components["responses"]["code_scanning_autofix_create_forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["code_scanning_bad_request"];
+ 403: components["responses"]["code_scanning_autofix_create_forbidden"];
+ 404: components["responses"]["not_found"];
/** @description Unprocessable Entity */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 503: components["responses"]["service_unavailable"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/commit-autofix": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/commit-autofix": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": components["schemas"]["code-scanning-autofix-commits"];
+ requestBody?: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-autofix-commits"];
};
};
- readonly responses: {
+ responses: {
/** @description Created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-autofix-commits-response"];
+ "application/json": components["schemas"]["code-scanning-autofix-commits-response"];
};
};
- readonly 400: components["responses"]["code_scanning_bad_request"];
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["code_scanning_bad_request"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
/** @description Unprocessable Entity */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 503: components["responses"]["service_unavailable"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/list-alert-instances": {
- readonly parameters: {
- readonly query?: {
+ "code-scanning/list-alert-instances": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- readonly ref?: components["parameters"]["git-ref"];
+ ref?: components["parameters"]["git-ref"];
/** @description The number of the pull request for the results you want to list. */
- readonly pr?: components["parameters"]["pr-alias"];
+ pr?: components["parameters"]["pr-alias"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */
- readonly alert_number: components["parameters"]["alert-number"];
+ alert_number: components["parameters"]["alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-scanning-alert-instance"][];
+ "application/json": components["schemas"]["code-scanning-alert-instance-list"][];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/list-recent-analyses": {
- readonly parameters: {
- readonly query?: {
+ "code-scanning/list-recent-analyses": {
+ parameters: {
+ query?: {
/** @description The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. */
- readonly tool_name?: components["parameters"]["tool-name"];
+ tool_name?: components["parameters"]["tool-name"];
/** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */
- readonly tool_guid?: components["parameters"]["tool-guid"];
+ tool_guid?: components["parameters"]["tool-guid"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The number of the pull request for the results you want to list. */
- readonly pr?: components["parameters"]["pr-alias"];
+ pr?: components["parameters"]["pr-alias"];
/** @description The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */
- readonly ref?: components["schemas"]["code-scanning-ref"];
+ ref?: components["schemas"]["code-scanning-ref"];
/** @description Filter analyses belonging to the same SARIF upload. */
- readonly sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"];
+ sarif_id?: components["schemas"]["code-scanning-analysis-sarif-id"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description The property by which to sort the results. */
- readonly sort?: "created";
+ sort?: "created";
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-scanning-analysis"][];
+ "application/json": components["schemas"]["code-scanning-analysis"][];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-analysis": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-analysis": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
- readonly analysis_id: number;
+ analysis_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-analysis"];
- readonly "application/json+sarif": {
- readonly [key: string]: unknown;
+ "application/json": components["schemas"]["code-scanning-analysis"];
+ "application/sarif+json": {
+ [key: string]: unknown;
};
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["unprocessable_analysis"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/delete-analysis": {
- readonly parameters: {
- readonly query?: {
+ "code-scanning/delete-analysis": {
+ parameters: {
+ query?: {
/** @description Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.` */
- readonly confirm_delete?: string | null;
+ confirm_delete?: string | null;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */
- readonly analysis_id: number;
+ analysis_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-analysis-deletion"];
+ "application/json": components["schemas"]["code-scanning-analysis-deletion"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/list-codeql-databases": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/list-codeql-databases": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["code-scanning-codeql-database"][];
+ "application/json": components["schemas"]["code-scanning-codeql-database"][];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-codeql-database": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-codeql-database": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The language of the CodeQL database. */
- readonly language: string;
+ language: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-codeql-database"];
+ "application/json": components["schemas"]["code-scanning-codeql-database"];
};
};
- readonly 302: components["responses"]["found"];
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 302: components["responses"]["found"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/delete-codeql-database": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/delete-codeql-database": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The language of the CodeQL database. */
- readonly language: string;
+ language: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/create-variant-analysis": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/create-variant-analysis": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly language: components["schemas"]["code-scanning-variant-analysis-language"];
+ requestBody: {
+ content: {
+ "application/json": {
+ language: components["schemas"]["code-scanning-variant-analysis-language"];
/** @description A Base64-encoded tarball containing a CodeQL query and all its dependencies */
- readonly query_pack: string;
+ query_pack: string;
/** @description List of repository names (in the form `owner/repo-name`) to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */
- readonly repositories?: readonly string[];
+ repositories?: string[];
/** @description List of repository lists to run the query against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */
- readonly repository_lists?: readonly string[];
+ repository_lists?: string[];
/** @description List of organization or user names whose repositories the query should be run against. Precisely one property from `repositories`, `repository_lists` and `repository_owners` is required. */
- readonly repository_owners?: readonly string[];
+ repository_owners?: string[];
} & (unknown | unknown | unknown);
};
};
- readonly responses: {
+ responses: {
/** @description Variant analysis submitted for processing */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-variant-analysis"];
+ "application/json": components["schemas"]["code-scanning-variant-analysis"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Unable to process variant analysis submission */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
- readonly 503: components["responses"]["service_unavailable"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-variant-analysis": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-variant-analysis": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the variant analysis. */
- readonly codeql_variant_analysis_id: number;
+ codeql_variant_analysis_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-variant-analysis"];
+ "application/json": components["schemas"]["code-scanning-variant-analysis"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-variant-analysis-repo-task": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-variant-analysis-repo-task": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the controller repository. */
- readonly repo: string;
+ repo: string;
/** @description The ID of the variant analysis. */
- readonly codeql_variant_analysis_id: number;
+ codeql_variant_analysis_id: number;
/** @description The account owner of the variant analysis repository. The name is not case sensitive. */
- readonly repo_owner: string;
+ repo_owner: string;
/** @description The name of the variant analysis repository. */
- readonly repo_name: string;
+ repo_name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"];
+ "application/json": components["schemas"]["code-scanning-variant-analysis-repo-task"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-default-setup": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-default-setup": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-default-setup"];
+ "application/json": components["schemas"]["code-scanning-default-setup"];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/update-default-setup": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/update-default-setup": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["code-scanning-default-setup-update"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["code-scanning-default-setup-update"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-default-setup-update-response"];
+ "application/json": components["schemas"]["code-scanning-default-setup-update-response"];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["code_scanning_conflict"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["code_scanning_conflict"];
+ 422: components["responses"]["code_scanning_invalid_state"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/upload-sarif": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/upload-sarif": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
- readonly ref: components["schemas"]["code-scanning-ref-full"];
- readonly sarif: components["schemas"]["code-scanning-analysis-sarif-file"];
+ requestBody: {
+ content: {
+ "application/json": {
+ commit_sha: components["schemas"]["code-scanning-analysis-commit-sha"];
+ ref: components["schemas"]["code-scanning-ref-full"];
+ sarif: components["schemas"]["code-scanning-analysis-sarif-file"];
/**
* Format: uri
* @description The base directory used in the analysis, as it appears in the SARIF file.
* This property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.
* @example file:///github/workspace/
*/
- readonly checkout_uri?: string;
+ checkout_uri?: string;
/**
* Format: date-time
* @description The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly started_at?: string;
+ started_at?: string;
/** @description The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to "API". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`. */
- readonly tool_name?: string;
+ tool_name?: string;
/**
* @description Whether the SARIF file will be validated according to the code scanning specifications.
* This parameter is intended to help integrators ensure that the uploaded SARIF files are correctly rendered by code scanning.
*/
- readonly validate?: boolean;
+ validate?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-sarifs-receipt"];
+ "application/json": components["schemas"]["code-scanning-sarifs-receipt"];
};
};
/** @description Bad Request if the sarif field is invalid */
- readonly 400: {
+ 400: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["code_scanning_forbidden_write"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["code_scanning_forbidden_write"];
+ 404: components["responses"]["not_found"];
/** @description Payload Too Large if the sarif field is too large */
- readonly 413: {
+ 413: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 503: components["responses"]["service_unavailable"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-scanning/get-sarif": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-scanning/get-sarif": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SARIF ID obtained after uploading. */
- readonly sarif_id: string;
+ sarif_id: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-scanning-sarifs-status"];
+ "application/json": components["schemas"]["code-scanning-sarifs-status"];
};
};
- readonly 403: components["responses"]["code_scanning_forbidden_read"];
+ 403: components["responses"]["code_scanning_forbidden_read"];
/** @description Not Found if the sarif id does not match any upload */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 503: components["responses"]["service_unavailable"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "code-security/get-configuration-for-repository": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "code-security/get-configuration-for-repository": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["code-security-configuration-for-repository"];
+ "application/json": components["schemas"]["code-security-configuration-for-repository"];
};
};
- readonly 204: components["responses"]["no_content"];
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 204: components["responses"]["no_content"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/codeowners-errors": {
- readonly parameters: {
- readonly query?: {
+ "repos/codeowners-errors": {
+ parameters: {
+ query?: {
/** @description A branch, tag or commit name used to determine which version of the CODEOWNERS file to use. Default: the repository's default branch (e.g. `main`) */
- readonly ref?: string;
+ ref?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codeowners-errors"];
+ "application/json": components["schemas"]["codeowners-errors"];
};
};
/** @description Resource not found */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "codespaces/list-in-repository-for-authenticated-user": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-in-repository-for-authenticated-user": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly codespaces: readonly components["schemas"]["codespace"][];
+ "application/json": {
+ total_count: number;
+ codespaces: components["schemas"]["codespace"][];
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/create-with-repo-for-authenticated-user": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/create-with-repo-for-authenticated-user": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Git ref (typically a branch name) for this codespace */
- readonly ref?: string;
+ ref?: string;
/** @description The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided. */
- readonly location?: string;
+ location?: string;
/**
* @description The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces `location`, which is closing down.
* @enum {string}
*/
- readonly geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
+ geo?: "EuropeWest" | "SoutheastAsia" | "UsEast" | "UsWest";
/** @description IP for location auto-detection when proxying a request */
- readonly client_ip?: string;
+ client_ip?: string;
/** @description Machine type to use for this codespace */
- readonly machine?: string;
+ machine?: string;
/** @description Path to devcontainer.json config to use for this codespace */
- readonly devcontainer_path?: string;
+ devcontainer_path?: string;
/** @description Whether to authorize requested permissions from devcontainer.json */
- readonly multi_repo_permissions_opt_out?: boolean;
+ multi_repo_permissions_opt_out?: boolean;
/** @description Working directory for this codespace */
- readonly working_directory?: string;
+ working_directory?: string;
/** @description Time in minutes before codespace stops from inactivity */
- readonly idle_timeout_minutes?: number;
+ idle_timeout_minutes?: number;
/** @description Display name for this codespace */
- readonly display_name?: string;
+ display_name?: string;
/** @description Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days). */
- readonly retention_period_minutes?: number;
+ retention_period_minutes?: number;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response when the codespace was successfully created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespace"];
+ "application/json": components["schemas"]["codespace"];
};
};
/** @description Response when the codespace creation partially failed but is being retried in the background */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespace"];
+ "application/json": components["schemas"]["codespace"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-devcontainers-in-repository-for-authenticated-user": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly devcontainers: readonly {
- readonly path: string;
- readonly name?: string;
- readonly display_name?: string;
+ "application/json": {
+ total_count: number;
+ devcontainers: {
+ path: string;
+ name?: string;
+ display_name?: string;
}[];
};
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/repo-machines-for-authenticated-user": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/repo-machines-for-authenticated-user": {
+ parameters: {
+ query?: {
/** @description The location to check for available machines. Assigned by IP if not provided. */
- readonly location?: string;
+ location?: string;
/** @description IP for location auto-detection when proxying a request */
- readonly client_ip?: string;
+ client_ip?: string;
/** @description The branch or commit to check for prebuild availability and devcontainer restrictions. */
- readonly ref?: string;
+ ref?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly machines: readonly components["schemas"]["codespace-machine"][];
+ "application/json": {
+ total_count: number;
+ machines: components["schemas"]["codespace-machine"][];
};
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
+ 304: components["responses"]["not_modified"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "codespaces/pre-flight-with-repo-for-authenticated-user": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/pre-flight-with-repo-for-authenticated-user": {
+ parameters: {
+ query?: {
/** @description The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. */
- readonly ref?: string;
+ ref?: string;
/** @description An alternative IP for default location auto-detection, such as when proxying a request. */
- readonly client_ip?: string;
+ client_ip?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response when a user is able to create codespaces from the repository. */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly billable_owner?: components["schemas"]["simple-user"];
- readonly defaults?: {
- readonly location: string;
- readonly devcontainer_path: string | null;
+ "application/json": {
+ billable_owner?: components["schemas"]["simple-user"];
+ defaults?: {
+ location: string;
+ devcontainer_path: string | null;
};
};
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "codespaces/check-permissions-for-devcontainer": {
- readonly parameters: {
- readonly query: {
+ "codespaces/check-permissions-for-devcontainer": {
+ parameters: {
+ query: {
/** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: string;
+ ref: string;
/** @description Path to the devcontainer.json configuration to use for the permission check. */
- readonly devcontainer_path: string;
+ devcontainer_path: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response when the permission check is successful */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"];
+ "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"];
};
};
- readonly 401: components["responses"]["requires_authentication"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["service_unavailable"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "codespaces/list-repo-secrets": {
- readonly parameters: {
- readonly query?: {
+ "codespaces/list-repo-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["repo-codespaces-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["repo-codespaces-secret"][];
};
};
};
};
};
- readonly "codespaces/get-repo-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/get-repo-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["codespaces-public-key"];
+ "application/json": components["schemas"]["codespaces-public-key"];
};
};
};
};
- readonly "codespaces/get-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/get-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repo-codespaces-secret"];
+ "application/json": components["schemas"]["repo-codespaces-secret"];
};
};
};
};
- readonly "codespaces/create-or-update-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/create-or-update-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value?: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "codespaces/delete-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "codespaces/delete-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-collaborators": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-collaborators": {
+ parameters: {
+ query?: {
/** @description Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */
- readonly affiliation?: "outside" | "direct" | "all";
+ affiliation?: "outside" | "direct" | "all";
/** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */
- readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin";
+ permission?: "pull" | "triage" | "push" | "maintain" | "admin";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["collaborator"][];
+ "application/json": components["schemas"]["collaborator"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/check-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/check-collaborator": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if user is a collaborator */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Not Found if user is not a collaborator */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/add-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/add-collaborator": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.
* @default push
*/
- readonly permission?: string;
+ permission?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when a new invitation is created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-invitation"];
+ "application/json": components["schemas"]["repository-invitation"];
};
};
/**
@@ -107235,974 +114692,990 @@ export interface operations {
* - an organization member is added as an individual collaborator
* - an existing team member (whose team is also a repository collaborator) is added as an individual collaborator
*/
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ /**
+ * @description Response when:
+ * - validation failed, or the endpoint has been spammed
+ * - an Enterprise Managed User (EMU) account was invited to a repository in an enterprise with personal user accounts
+ */
+ 422: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["validation-error"];
+ };
+ };
};
};
- readonly "repos/remove-collaborator": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/remove-collaborator": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description No Content when collaborator was removed from the repository. */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-collaborator-permission-level": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-collaborator-permission-level": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The handle for the GitHub user account. */
- readonly username: components["parameters"]["username"];
+ username: components["parameters"]["username"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description if user has admin permissions */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-collaborator-permission"];
+ "application/json": components["schemas"]["repository-collaborator-permission"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/list-commit-comments-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-commit-comments-for-repo": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["commit-comment"][];
+ "application/json": components["schemas"]["commit-comment"][];
};
};
};
};
- readonly "repos/get-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["commit-comment"];
+ "application/json": components["schemas"]["commit-comment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/update-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The contents of the comment */
- readonly body: string;
+ body: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["commit-comment"];
+ "application/json": components["schemas"]["commit-comment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "reactions/list-for-commit-comment": {
- readonly parameters: {
- readonly query?: {
+ "reactions/list-for-commit-comment": {
+ parameters: {
+ query?: {
/** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */
- readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "reactions/create-for-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/create-for-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the commit comment.
* @enum {string}
*/
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
};
};
};
- readonly responses: {
+ responses: {
/** @description Reaction exists */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
/** @description Reaction created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/delete-for-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/delete-for-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
/** @description The unique identifier of the reaction. */
- readonly reaction_id: components["parameters"]["reaction-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-commits": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-commits": {
+ parameters: {
+ query?: {
/** @description SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`). */
- readonly sha?: string;
+ sha?: string;
/** @description Only commits containing this file path will be returned. */
- readonly path?: string;
+ path?: string;
/** @description GitHub username or email address to use to filter by commit author. */
- readonly author?: string;
+ author?: string;
/** @description GitHub username or email address to use to filter by commit committer. */
- readonly committer?: string;
+ committer?: string;
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */
- readonly since?: string;
+ since?: string;
/** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Due to limitations of Git, timestamps must be between 1970-01-01 and 2099-12-31 (inclusive) or unexpected results may be returned. */
- readonly until?: string;
+ until?: string;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["commit"][];
+ "application/json": components["schemas"]["commit"][];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 500: components["responses"]["internal_error"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 500: components["responses"]["internal_error"];
};
};
- readonly "repos/list-branches-for-head-commit": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/list-branches-for-head-commit": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA of the commit. */
- readonly commit_sha: components["parameters"]["commit-sha"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["branch-short"][];
+ "application/json": components["schemas"]["branch-short"][];
};
};
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/list-comments-for-commit": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-comments-for-commit": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA of the commit. */
- readonly commit_sha: components["parameters"]["commit-sha"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["commit-comment"][];
+ "application/json": components["schemas"]["commit-comment"][];
};
};
};
};
- readonly "repos/create-commit-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-commit-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA of the commit. */
- readonly commit_sha: components["parameters"]["commit-sha"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The contents of the comment. */
- readonly body: string;
+ body: string;
/** @description Relative path of the file to comment on. */
- readonly path?: string;
+ path?: string;
/** @description Line index in the diff to comment on. */
- readonly position?: number;
+ position?: number;
/** @description **Closing down notice**. Use **position** parameter instead. Line number in the file to comment on. */
- readonly line?: number;
+ line?: number;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/comments/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["commit-comment"];
+ "application/json": components["schemas"]["commit-comment"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/list-pull-requests-associated-with-commit": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-pull-requests-associated-with-commit": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA of the commit. */
- readonly commit_sha: components["parameters"]["commit-sha"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["pull-request-simple"][];
+ "application/json": components["schemas"]["pull-request-simple"][];
};
};
- readonly 409: components["responses"]["conflict"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "repos/get-commit": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-commit": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: components["parameters"]["commit-ref"];
+ ref: components["parameters"]["commit-ref"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["commit"];
+ "application/json": components["schemas"]["commit"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 500: components["responses"]["internal_error"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "checks/list-for-ref": {
- readonly parameters: {
- readonly query?: {
+ "checks/list-for-ref": {
+ parameters: {
+ query?: {
/** @description Returns check runs with the specified `name`. */
- readonly check_name?: components["parameters"]["check-name"];
+ check_name?: components["parameters"]["check-name"];
/** @description Returns check runs with the specified `status`. */
- readonly status?: components["parameters"]["status"];
+ status?: components["parameters"]["status"];
/** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */
- readonly filter?: "latest" | "all";
+ filter?: "latest" | "all";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
- readonly app_id?: number;
+ page?: components["parameters"]["page"];
+ app_id?: number;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: components["parameters"]["commit-ref"];
+ ref: components["parameters"]["commit-ref"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly check_runs: readonly components["schemas"]["check-run"][];
+ "application/json": {
+ total_count: number;
+ check_runs: components["schemas"]["check-run"][];
};
};
};
};
};
- readonly "checks/list-suites-for-ref": {
- readonly parameters: {
- readonly query?: {
+ "checks/list-suites-for-ref": {
+ parameters: {
+ query?: {
/**
* @description Filters check suites by GitHub App `id`.
* @example 1
*/
- readonly app_id?: number;
+ app_id?: number;
/** @description Returns check runs with the specified `name`. */
- readonly check_name?: components["parameters"]["check-name"];
+ check_name?: components["parameters"]["check-name"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: components["parameters"]["commit-ref"];
+ ref: components["parameters"]["commit-ref"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly check_suites: readonly components["schemas"]["check-suite"][];
+ "application/json": {
+ total_count: number;
+ check_suites: components["schemas"]["check-suite"][];
};
};
};
};
};
- readonly "repos/get-combined-status-for-ref": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-combined-status-for-ref": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: components["parameters"]["commit-ref"];
+ ref: components["parameters"]["commit-ref"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["combined-commit-status"];
+ "application/json": components["schemas"]["combined-commit-status"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/list-commit-statuses-for-ref": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-commit-statuses-for-ref": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */
- readonly ref: components["parameters"]["commit-ref"];
+ ref: components["parameters"]["commit-ref"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["status"][];
+ "application/json": components["schemas"]["status"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
+ 301: components["responses"]["moved_permanently"];
};
};
- readonly "repos/get-community-profile-metrics": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-community-profile-metrics": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["community-profile"];
+ "application/json": components["schemas"]["community-profile"];
};
};
};
};
- readonly "repos/compare-commits": {
- readonly parameters: {
- readonly query?: {
+ "repos/compare-commits": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`. */
- readonly basehead: string;
+ basehead: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["commit-comparison"];
+ "application/json": components["schemas"]["commit-comparison"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 500: components["responses"]["internal_error"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 500: components["responses"]["internal_error"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "repos/get-content": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-content": {
+ parameters: {
+ query?: {
/** @description The name of the commit/branch/tag. Default: the repository’s default branch. */
- readonly ref?: string;
+ ref?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description path parameter */
- readonly path: string;
+ path: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: {
+ content: {
+ "application/json": unknown;
+ };
+ };
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/vnd.github.object": components["schemas"]["content-tree"];
- readonly "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"];
+ "application/vnd.github.object": components["schemas"]["content-tree"];
+ "application/json": components["schemas"]["content-directory"] | components["schemas"]["content-file"] | components["schemas"]["content-symlink"] | components["schemas"]["content-submodule"];
};
};
- readonly 302: components["responses"]["found"];
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 302: components["responses"]["found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/create-or-update-file-contents": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-or-update-file-contents": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description path parameter */
- readonly path: string;
+ path: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The commit message. */
- readonly message: string;
+ message: string;
/** @description The new file content, using Base64 encoding. */
- readonly content: string;
+ content: string;
/** @description **Required if you are updating a file**. The blob SHA of the file being replaced. */
- readonly sha?: string;
+ sha?: string;
/** @description The branch name. Default: the repository’s default branch. */
- readonly branch?: string;
+ branch?: string;
/** @description The person that committed the file. Default: the authenticated user. */
- readonly committer?: {
+ committer?: {
/** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
- readonly name: string;
+ name: string;
/** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
- readonly email: string;
+ email: string;
/** @example "2013-01-05T13:13:22+05:00" */
- readonly date?: string;
+ date?: string;
};
/** @description The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. */
- readonly author?: {
+ author?: {
/** @description The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. */
- readonly name: string;
+ name: string;
/** @description The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. */
- readonly email: string;
+ email: string;
/** @example "2013-01-15T17:13:22+05:00" */
- readonly date?: string;
+ date?: string;
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["file-commit"];
+ "application/json": components["schemas"]["file-commit"];
};
};
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["file-commit"];
+ "application/json": components["schemas"]["file-commit"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
/** @description Conflict */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"];
+ "application/json": components["schemas"]["basic-error"] | components["schemas"]["repository-rule-violation-error"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/delete-file": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-file": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description path parameter */
- readonly path: string;
+ path: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The commit message. */
- readonly message: string;
+ message: string;
/** @description The blob SHA of the file being deleted. */
- readonly sha: string;
+ sha: string;
/** @description The branch name. Default: the repository’s default branch */
- readonly branch?: string;
+ branch?: string;
/** @description object containing information about the committer. */
- readonly committer?: {
+ committer?: {
/** @description The name of the author (or committer) of the commit */
- readonly name?: string;
+ name?: string;
/** @description The email of the author (or committer) of the commit */
- readonly email?: string;
+ email?: string;
};
/** @description object containing information about the author. */
- readonly author?: {
+ author?: {
/** @description The name of the author (or committer) of the commit */
- readonly name?: string;
+ name?: string;
/** @description The email of the author (or committer) of the commit */
- readonly email?: string;
+ email?: string;
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["file-commit"];
+ "application/json": components["schemas"]["file-commit"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["service_unavailable"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "repos/list-contributors": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-contributors": {
+ parameters: {
+ query?: {
/** @description Set to `1` or `true` to include anonymous contributors in results. */
- readonly anon?: string;
+ anon?: string;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description If repository contains content */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["contributor"][];
+ "application/json": components["schemas"]["contributor"][];
};
};
/** @description Response if repository is empty */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "dependabot/list-alerts-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-alerts-for-repo": {
+ parameters: {
+ query?: {
/**
* @description A comma-separated list of states. If specified, only alerts with these states will be returned.
*
* Can be: `auto_dismissed`, `dismissed`, `fixed`, `open`
*/
- readonly state?: components["parameters"]["dependabot-alert-comma-separated-states"];
+ state?: components["parameters"]["dependabot-alert-comma-separated-states"];
/**
* @description A comma-separated list of severities. If specified, only alerts with these severities will be returned.
*
* Can be: `low`, `medium`, `high`, `critical`
*/
- readonly severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
+ severity?: components["parameters"]["dependabot-alert-comma-separated-severities"];
/**
* @description A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
*
* Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
*/
- readonly ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
+ ecosystem?: components["parameters"]["dependabot-alert-comma-separated-ecosystems"];
/** @description A comma-separated list of package names. If specified, only alerts for these packages will be returned. */
- readonly package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
+ package?: components["parameters"]["dependabot-alert-comma-separated-packages"];
/** @description A comma-separated list of full manifest paths. If specified, only alerts for these manifests will be returned. */
- readonly manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"];
+ manifest?: components["parameters"]["dependabot-alert-comma-separated-manifests"];
/**
* @description CVE Exploit Prediction Scoring System (EPSS) percentage. Can be specified as:
* - An exact number (`n`)
@@ -108211,648 +115684,645 @@ export interface operations {
*
* Filters the list of alerts based on EPSS percentages. If specified, only alerts with the provided EPSS percentages will be returned.
*/
- readonly epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ epss_percentage?: components["parameters"]["dependabot-alert-comma-separated-epss"];
+ /**
+ * @description Filters the list of alerts based on whether the alert has the given value. If specified, only alerts meeting this criterion will be returned.
+ * Multiple `has` filters can be passed to filter for alerts that have all of the values. Currently, only `patch` is supported.
+ */
+ has?: components["parameters"]["dependabot-alert-comma-separated-has"];
+ /**
+ * @description Filter alerts by assignees.
+ * Provide a comma-separated list of user handles (e.g., `octocat` or `octocat,hubot`) to return alerts assigned to any of the specified users.
+ * Use `*` to list alerts with at least one assignee or `none` to list alerts with no assignees.
+ */
+ assignee?: components["parameters"]["dependabot-alert-comma-separated-assignees"];
/** @description The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. */
- readonly scope?: components["parameters"]["dependabot-alert-scope"];
+ scope?: components["parameters"]["dependabot-alert-scope"];
/**
* @description The property by which to sort the results.
* `created` means when the alert was created.
* `updated` means when the alert's state last changed.
* `epss_percentage` sorts alerts by the Exploit Prediction Scoring System (EPSS) percentage.
*/
- readonly sort?: components["parameters"]["dependabot-alert-sort"];
+ sort?: components["parameters"]["dependabot-alert-sort"];
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
- /**
- * @deprecated
- * @description **Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.
- */
- readonly page?: number;
- /**
- * @deprecated
- * @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
- */
- readonly per_page?: number;
+ direction?: components["parameters"]["direction"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly before?: components["parameters"]["pagination-before"];
+ before?: components["parameters"]["pagination-before"];
/** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly after?: components["parameters"]["pagination-after"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the first matching result.
- * This parameter must not be used in combination with `last`.
- * Instead, use `per_page` in combination with `after` to fetch the first page of results.
- */
- readonly first?: components["parameters"]["pagination-first"];
- /**
- * @description **Deprecated**. The number of results per page (max 100), starting from the last matching result.
- * This parameter must not be used in combination with `first`.
- * Instead, use `per_page` in combination with `before` to fetch the last page of results.
- */
- readonly last?: components["parameters"]["pagination-last"];
+ after?: components["parameters"]["pagination-after"];
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["dependabot-alert"][];
+ "application/json": components["schemas"]["dependabot-alert"][];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 304: components["responses"]["not_modified"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "dependabot/get-alert": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/get-alert": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The number that identifies a Dependabot alert in its repository.
* You can find this at the end of the URL for a Dependabot alert within GitHub,
* or in `number` fields in the response from the
* `GET /repos/{owner}/{repo}/dependabot/alerts` operation.
*/
- readonly alert_number: components["parameters"]["dependabot-alert-number"];
+ alert_number: components["parameters"]["dependabot-alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependabot-alert"];
+ "application/json": components["schemas"]["dependabot-alert"];
};
};
- readonly 304: components["responses"]["not_modified"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 304: components["responses"]["not_modified"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "dependabot/update-alert": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/update-alert": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The number that identifies a Dependabot alert in its repository.
* You can find this at the end of the URL for a Dependabot alert within GitHub,
* or in `number` fields in the response from the
* `GET /repos/{owner}/{repo}/dependabot/alerts` operation.
*/
- readonly alert_number: components["parameters"]["dependabot-alert-number"];
+ alert_number: components["parameters"]["dependabot-alert-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The state of the Dependabot alert.
* A `dismissed_reason` must be provided when setting the state to `dismissed`.
* @enum {string}
*/
- readonly state: "dismissed" | "open";
+ state?: "dismissed" | "open";
/**
* @description **Required when `state` is `dismissed`.** A reason for dismissing the alert.
* @enum {string}
*/
- readonly dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk";
+ dismissed_reason?: "fix_started" | "inaccurate" | "no_bandwidth" | "not_used" | "tolerable_risk";
/** @description An optional comment associated with dismissing the alert. */
- readonly dismissed_comment?: string;
- };
+ dismissed_comment?: string;
+ /**
+ * @description Usernames to assign to this Dependabot Alert.
+ * Pass one or more user logins to _replace_ the set of assignees on this alert.
+ * Send an empty array (`[]`) to clear all assignees from the alert.
+ */
+ assignees?: string[];
+ } | unknown | unknown;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependabot-alert"];
+ "application/json": components["schemas"]["dependabot-alert"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "dependabot/list-repo-secrets": {
- readonly parameters: {
- readonly query?: {
+ "dependabot/list-repo-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["dependabot-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["dependabot-secret"][];
};
};
};
};
};
- readonly "dependabot/get-repo-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/get-repo-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependabot-public-key"];
+ "application/json": components["schemas"]["dependabot-public-key"];
};
};
};
};
- readonly "dependabot/get-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/get-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependabot-secret"];
+ "application/json": components["schemas"]["dependabot-secret"];
};
};
};
};
- readonly "dependabot/create-or-update-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/create-or-update-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key) endpoint. */
- readonly encrypted_value?: string;
+ encrypted_value?: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id?: string;
+ key_id?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependabot/delete-repo-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependabot/delete-repo-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "dependency-graph/diff-range": {
- readonly parameters: {
- readonly query?: {
+ "dependency-graph/diff-range": {
+ parameters: {
+ query?: {
/** @description The full path, relative to the repository root, of the dependency manifest file. */
- readonly name?: components["parameters"]["manifest-path"];
+ name?: components["parameters"]["manifest-path"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The base and head Git revisions to compare. The Git revisions will be resolved to commit SHAs. Named revisions will be resolved to their corresponding HEAD commits, and an appropriate merge base will be determined. This parameter expects the format `{base}...{head}`. */
- readonly basehead: string;
+ basehead: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependency-graph-diff"];
+ "application/json": components["schemas"]["dependency-graph-diff"];
};
};
- readonly 403: components["responses"]["dependency_review_forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["dependency_review_forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "dependency-graph/export-sbom": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependency-graph/export-sbom": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["dependency-graph-spdx-sbom"];
+ "application/json": components["schemas"]["dependency-graph-spdx-sbom"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "dependency-graph/create-repository-snapshot": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "dependency-graph/create-repository-snapshot": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["snapshot"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["snapshot"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/** @description ID of the created snapshot. */
- readonly id: number;
+ id: number;
/** @description The time at which the snapshot was created. */
- readonly created_at: string;
+ created_at: string;
/** @description Either "SUCCESS", "ACCEPTED", or "INVALID". "SUCCESS" indicates that the snapshot was successfully created and the repository's dependencies were updated. "ACCEPTED" indicates that the snapshot was successfully created, but the repository's dependencies were not updated. "INVALID" indicates that the snapshot was malformed. */
- readonly result: string;
+ result: string;
/** @description A message providing further details about the result, such as why the dependencies were not updated. */
- readonly message: string;
+ message: string;
};
};
};
};
};
- readonly "repos/list-deployments": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-deployments": {
+ parameters: {
+ query?: {
/** @description The SHA recorded at creation time. */
- readonly sha?: string;
+ sha?: string;
/** @description The name of the ref. This can be a branch, tag, or SHA. */
- readonly ref?: string;
+ ref?: string;
/** @description The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`). */
- readonly task?: string;
+ task?: string;
/** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */
- readonly environment?: string | null;
+ environment?: string | null;
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["deployment"][];
+ "application/json": components["schemas"]["deployment"][];
};
};
};
};
- readonly "repos/create-deployment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-deployment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The ref to deploy. This can be a branch, tag, or SHA. */
- readonly ref: string;
+ ref: string;
/**
* @description Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).
* @default deploy
*/
- readonly task?: string;
+ task?: string;
/**
* @description Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.
* @default true
*/
- readonly auto_merge?: boolean;
+ auto_merge?: boolean;
/** @description The [status](https://docs.github.com/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts. */
- readonly required_contexts?: readonly string[];
- readonly payload?: {
- readonly [key: string]: unknown;
+ required_contexts?: string[];
+ payload?: {
+ [key: string]: unknown;
} | string;
/**
* @description Name for the target deployment environment (e.g., `production`, `staging`, `qa`).
* @default production
*/
- readonly environment?: string;
+ environment?: string;
/**
* @description Short description of the deployment.
* @default
*/
- readonly description?: string | null;
+ description?: string | null;
/**
* @description Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`
* @default false
*/
- readonly transient_environment?: boolean;
+ transient_environment?: boolean;
/** @description Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. */
- readonly production_environment?: boolean;
+ production_environment?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment"];
+ "application/json": components["schemas"]["deployment"];
};
};
/** @description Merged branch response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly message?: string;
+ "application/json": {
+ message?: string;
};
};
};
/** @description Conflict when there is a merge conflict or the commit's status checks failed */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-deployment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-deployment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description deployment_id parameter */
- readonly deployment_id: components["parameters"]["deployment-id"];
+ deployment_id: components["parameters"]["deployment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment"];
+ "application/json": components["schemas"]["deployment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-deployment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-deployment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description deployment_id parameter */
- readonly deployment_id: components["parameters"]["deployment-id"];
+ deployment_id: components["parameters"]["deployment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
};
};
- readonly "repos/list-deployment-statuses": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-deployment-statuses": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description deployment_id parameter */
- readonly deployment_id: components["parameters"]["deployment-id"];
+ deployment_id: components["parameters"]["deployment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["deployment-status"][];
+ "application/json": components["schemas"]["deployment-status"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/create-deployment-status": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-deployment-status": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description deployment_id parameter */
- readonly deployment_id: components["parameters"]["deployment-id"];
+ deployment_id: components["parameters"]["deployment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.
* @enum {string}
*/
- readonly state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success";
+ state: "error" | "failure" | "inactive" | "in_progress" | "queued" | "pending" | "success";
/**
* @description The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment.
*
@@ -108860,1613 +116330,1619 @@ export interface operations {
* > It's recommended to use the `log_url` parameter, which replaces `target_url`.
* @default
*/
- readonly target_url?: string;
+ target_url?: string;
/**
* @description The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""`
* @default
*/
- readonly log_url?: string;
+ log_url?: string;
/**
* @description A short description of the status. The maximum description length is 140 characters.
* @default
*/
- readonly description?: string;
+ description?: string;
/** @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. */
- readonly environment?: string;
+ environment?: string;
/**
* @description Sets the URL for accessing your environment. Default: `""`
* @default
*/
- readonly environment_url?: string;
+ environment_url?: string;
/** @description Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` */
- readonly auto_inactive?: boolean;
+ auto_inactive?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/example/deployments/42/statuses/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-status"];
+ "application/json": components["schemas"]["deployment-status"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-deployment-status": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-deployment-status": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description deployment_id parameter */
- readonly deployment_id: components["parameters"]["deployment-id"];
- readonly status_id: number;
+ deployment_id: components["parameters"]["deployment-id"];
+ status_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-status"];
+ "application/json": components["schemas"]["deployment-status"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/create-dispatch-event": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-dispatch-event": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description A custom webhook event name. Must be 100 characters or fewer. */
- readonly event_type: string;
+ event_type: string;
/** @description JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10. The total size of the JSON payload must be less than 64KB. */
- readonly client_payload?: {
- readonly [key: string]: unknown;
+ client_payload?: {
+ [key: string]: unknown;
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-all-environments": {
- readonly parameters: {
- readonly query?: {
+ "repos/get-all-environments": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description The number of environments in this repository
* @example 5
*/
- readonly total_count?: number;
- readonly environments?: readonly components["schemas"]["environment"][];
+ total_count?: number;
+ environments?: components["schemas"]["environment"][];
};
};
};
};
};
- readonly "repos/get-environment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-environment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["environment"];
+ "application/json": components["schemas"]["environment"];
};
};
};
};
- readonly "repos/create-or-update-environment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-or-update-environment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- readonly wait_timer?: components["schemas"]["wait-timer"];
- readonly prevent_self_review?: components["schemas"]["prevent-self-review"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ wait_timer?: components["schemas"]["wait-timer"];
+ prevent_self_review?: components["schemas"]["prevent-self-review"];
/** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */
- readonly reviewers?: readonly {
- readonly type?: components["schemas"]["deployment-reviewer-type"];
+ reviewers?: {
+ type?: components["schemas"]["deployment-reviewer-type"];
/**
* @description The id of the user or team who can review the deployment
* @example 4532992
*/
- readonly id?: number;
+ id?: number;
}[] | null;
- readonly deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
+ deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"];
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["environment"];
+ "application/json": components["schemas"]["environment"];
};
};
/** @description Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "repos/delete-an-environment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-an-environment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Default response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-deployment-branch-policies": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-deployment-branch-policies": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description The number of deployment branch policies for the environment.
* @example 2
*/
- readonly total_count: number;
- readonly branch_policies: readonly components["schemas"]["deployment-branch-policy"][];
+ total_count: number;
+ branch_policies: components["schemas"]["deployment-branch-policy"][];
};
};
};
};
};
- readonly "repos/create-deployment-branch-policy": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-deployment-branch-policy": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-branch-policy"];
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
/** @description Response if the same branch name pattern already exists */
- readonly 303: {
+ 303: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/get-deployment-branch-policy": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-deployment-branch-policy": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
- readonly branch_policy_id: components["parameters"]["branch-policy-id"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-branch-policy"];
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
};
};
- readonly "repos/update-deployment-branch-policy": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-deployment-branch-policy": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
- readonly branch_policy_id: components["parameters"]["branch-policy-id"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["deployment-branch-policy-name-pattern"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["deployment-branch-policy-name-pattern"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-branch-policy"];
+ "application/json": components["schemas"]["deployment-branch-policy"];
};
};
};
};
- readonly "repos/delete-deployment-branch-policy": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-deployment-branch-policy": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the branch policy. */
- readonly branch_policy_id: components["parameters"]["branch-policy-id"];
+ branch_policy_id: components["parameters"]["branch-policy-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/get-all-deployment-protection-rules": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-all-deployment-protection-rules": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description List of deployment protection rules */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description The number of enabled custom deployment protection rules for this environment
* @example 10
*/
- readonly total_count?: number;
- readonly custom_deployment_protection_rules?: readonly components["schemas"]["deployment-protection-rule"][];
+ total_count?: number;
+ custom_deployment_protection_rules?: components["schemas"]["deployment-protection-rule"][];
};
};
};
};
};
- readonly "repos/create-deployment-protection-rule": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-deployment-protection-rule": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The ID of the custom app that will be enabled on the environment. */
- readonly integration_id?: number;
+ integration_id?: number;
};
};
};
- readonly responses: {
+ responses: {
/** @description The enabled custom deployment protection rule */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-protection-rule"];
+ "application/json": components["schemas"]["deployment-protection-rule"];
};
};
};
};
- readonly "repos/list-custom-deployment-rule-integrations": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-custom-deployment-rule-integrations": {
+ parameters: {
+ query?: {
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description A list of custom deployment rule integrations available for this environment. */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
+ "application/json": {
/**
* @description The total number of custom deployment protection rule integrations available for this environment.
* @example 35
*/
- readonly total_count?: number;
- readonly available_custom_deployment_protection_rule_integrations?: readonly components["schemas"]["custom-deployment-rule-app"][];
+ total_count?: number;
+ available_custom_deployment_protection_rule_integrations?: components["schemas"]["custom-deployment-rule-app"][];
};
};
};
};
};
- readonly "repos/get-custom-deployment-protection-rule": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-custom-deployment-protection-rule": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The unique identifier of the protection rule. */
- readonly protection_rule_id: components["parameters"]["protection-rule-id"];
+ protection_rule_id: components["parameters"]["protection-rule-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deployment-protection-rule"];
+ "application/json": components["schemas"]["deployment-protection-rule"];
};
};
};
};
- readonly "repos/disable-deployment-protection-rule": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/disable-deployment-protection-rule": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The unique identifier of the protection rule. */
- readonly protection_rule_id: components["parameters"]["protection-rule-id"];
+ protection_rule_id: components["parameters"]["protection-rule-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-environment-secrets": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-environment-secrets": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly secrets: readonly components["schemas"]["actions-secret"][];
+ "application/json": {
+ total_count: number;
+ secrets: components["schemas"]["actions-secret"][];
};
};
};
};
};
- readonly "actions/get-environment-public-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-environment-public-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-public-key"];
+ "application/json": components["schemas"]["actions-public-key"];
};
};
};
};
- readonly "actions/get-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-environment-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-secret"];
+ "application/json": components["schemas"]["actions-secret"];
};
};
};
};
- readonly "actions/create-or-update-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-or-update-environment-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */
- readonly encrypted_value: string;
+ encrypted_value: string;
/** @description ID of the key you used to encrypt the secret. */
- readonly key_id: string;
+ key_id: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response when creating a secret */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
/** @description Response when updating a secret */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/delete-environment-secret": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-environment-secret": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the secret. */
- readonly secret_name: components["parameters"]["secret-name"];
+ secret_name: components["parameters"]["secret-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Default response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/list-environment-variables": {
- readonly parameters: {
- readonly query?: {
+ "actions/list-environment-variables": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 30). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["variables-per-page"];
+ per_page?: components["parameters"]["variables-per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": {
- readonly total_count: number;
- readonly variables: readonly components["schemas"]["actions-variable"][];
+ "application/json": {
+ total_count: number;
+ variables: components["schemas"]["actions-variable"][];
};
};
};
};
};
- readonly "actions/create-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/create-environment-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name: string;
+ name: string;
/** @description The value of the variable. */
- readonly value: string;
+ value: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["empty-object"];
+ "application/json": components["schemas"]["empty-object"];
};
};
};
};
- readonly "actions/get-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/get-environment-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["actions-variable"];
+ "application/json": components["schemas"]["actions-variable"];
};
};
};
};
- readonly "actions/delete-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/delete-environment-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "actions/update-environment-variable": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "actions/update-environment-variable": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The name of the variable. */
- readonly name: components["parameters"]["variable-name"];
+ name: components["parameters"]["variable-name"];
/** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */
- readonly environment_name: components["parameters"]["environment-name"];
+ environment_name: components["parameters"]["environment-name"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the variable. */
- readonly name?: string;
+ name?: string;
/** @description The value of the variable. */
- readonly value?: string;
+ value?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "activity/list-repo-events": {
- readonly parameters: {
- readonly query?: {
+ "activity/list-repo-events": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["event"][];
+ "application/json": components["schemas"]["event"][];
};
};
};
};
- readonly "repos/list-forks": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-forks": {
+ parameters: {
+ query?: {
/** @description The sort order. `stargazers` will sort by star count. */
- readonly sort?: "newest" | "oldest" | "stargazers" | "watchers";
+ sort?: "newest" | "oldest" | "stargazers" | "watchers";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["minimal-repository"][];
+ "application/json": components["schemas"]["minimal-repository"][];
};
};
- readonly 400: components["responses"]["bad_request"];
+ 400: components["responses"]["bad_request"];
};
};
- readonly "repos/create-fork": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-fork": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Optional parameter to specify the organization name if forking into an organization. */
- readonly organization?: string;
+ organization?: string;
/** @description When forking from an existing repository, a new name for the fork. */
- readonly name?: string;
+ name?: string;
/** @description When forking from an existing repository, fork with only the default branch. */
- readonly default_branch_only?: boolean;
+ default_branch_only?: boolean;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 202: {
+ 202: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["full-repository"];
+ "application/json": components["schemas"]["full-repository"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/create-blob": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/create-blob": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The new blob's content. */
- readonly content: string;
+ content: string;
/**
* @description The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported.
* @default utf-8
*/
- readonly encoding?: string;
+ encoding?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["short-blob"];
+ "application/json": components["schemas"]["short-blob"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
/** @description Validation failed */
- readonly 422: {
+ 422: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"];
+ "application/json": components["schemas"]["validation-error"] | components["schemas"]["repository-rule-violation-error"];
};
};
};
};
- readonly "git/get-blob": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/get-blob": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly file_sha: string;
+ repo: components["parameters"]["repo"];
+ file_sha: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["blob"];
+ "application/json": components["schemas"]["blob"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/create-commit": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/create-commit": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The commit message */
- readonly message: string;
+ message: string;
/** @description The SHA of the tree object this commit points to */
- readonly tree: string;
+ tree: string;
/** @description The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. */
- readonly parents?: readonly string[];
+ parents?: string[];
/** @description Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. */
- readonly author?: {
+ author?: {
/** @description The name of the author (or committer) of the commit */
- readonly name: string;
+ name: string;
/** @description The email of the author (or committer) of the commit */
- readonly email: string;
+ email: string;
/**
* Format: date-time
* @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly date?: string;
+ date?: string;
};
/** @description Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. */
- readonly committer?: {
+ committer?: {
/** @description The name of the author (or committer) of the commit */
- readonly name?: string;
+ name?: string;
/** @description The email of the author (or committer) of the commit */
- readonly email?: string;
+ email?: string;
/**
* Format: date-time
* @description Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly date?: string;
+ date?: string;
};
/** @description The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. */
- readonly signature?: string;
+ signature?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-commit"];
+ "application/json": components["schemas"]["git-commit"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/get-commit": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/get-commit": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA of the commit. */
- readonly commit_sha: components["parameters"]["commit-sha"];
+ commit_sha: components["parameters"]["commit-sha"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-commit"];
+ "application/json": components["schemas"]["git-commit"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "git/list-matching-refs": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/list-matching-refs": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
* @example heads/feature-a
*/
- readonly ref: components["parameters"]["git-ref-only"];
+ ref: components["parameters"]["git-ref-only"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["git-ref"][];
+ "application/json": components["schemas"]["git-ref"][];
};
};
- readonly 409: components["responses"]["conflict"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "git/get-ref": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/get-ref": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
* @example heads/feature-a
*/
- readonly ref: components["parameters"]["git-ref-only"];
+ ref: components["parameters"]["git-ref-only"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-ref"];
+ "application/json": components["schemas"]["git-ref"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "git/create-ref": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/create-ref": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected. */
- readonly ref: string;
+ ref: string;
/** @description The SHA1 value for this reference. */
- readonly sha: string;
+ sha: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-ref"];
+ "application/json": components["schemas"]["git-ref"];
};
};
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/delete-ref": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/delete-ref": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
* @example heads/feature-a
*/
- readonly ref: components["parameters"]["git-ref-only"];
+ ref: components["parameters"]["git-ref-only"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 409: components["responses"]["conflict"];
+ /** @description Validation failed, an attempt was made to delete the default branch, or the endpoint has been spammed. */
+ 422: {
+ headers: {
+ [name: string]: unknown;
};
content?: never;
};
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
};
};
- readonly "git/update-ref": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/update-ref": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/**
* @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
* @example heads/feature-a
*/
- readonly ref: components["parameters"]["git-ref-only"];
+ ref: components["parameters"]["git-ref-only"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The SHA1 value to set this reference to */
- readonly sha: string;
+ sha: string;
/**
* @description Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.
* @default false
*/
- readonly force?: boolean;
+ force?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-ref"];
+ "application/json": components["schemas"]["git-ref"];
};
};
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/create-tag": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/create-tag": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The tag's name. This is typically a version (e.g., "v0.0.1"). */
- readonly tag: string;
+ tag: string;
/** @description The tag message. */
- readonly message: string;
+ message: string;
/** @description The SHA of the git object this is tagging. */
- readonly object: string;
+ object: string;
/**
* @description The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.
* @enum {string}
*/
- readonly type: "commit" | "tree" | "blob";
+ type: "commit" | "tree" | "blob";
/** @description An object with information about the individual creating the tag. */
- readonly tagger?: {
+ tagger?: {
/** @description The name of the author of the tag */
- readonly name: string;
+ name: string;
/** @description The email of the author of the tag */
- readonly email: string;
+ email: string;
/**
* Format: date-time
* @description When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
*/
- readonly date?: string;
+ date?: string;
};
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-tag"];
+ "application/json": components["schemas"]["git-tag"];
};
};
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/get-tag": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/get-tag": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly tag_sha: string;
+ repo: components["parameters"]["repo"];
+ tag_sha: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-tag"];
+ "application/json": components["schemas"]["git-tag"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
};
};
- readonly "git/create-tree": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "git/create-tree": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure. */
- readonly tree: readonly {
+ tree: {
/** @description The file referenced in the tree. */
- readonly path?: string;
+ path?: string;
/**
* @description The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.
* @enum {string}
*/
- readonly mode?: "100644" | "100755" | "040000" | "160000" | "120000";
+ mode?: "100644" | "100755" | "040000" | "160000" | "120000";
/**
* @description Either `blob`, `tree`, or `commit`.
* @enum {string}
*/
- readonly type?: "blob" | "tree" | "commit";
+ type?: "blob" | "tree" | "commit";
/**
* @description The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted.
*
* **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
*/
- readonly sha?: string | null;
+ sha?: string | null;
/**
* @description The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`.
*
* **Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.
*/
- readonly content?: string;
+ content?: string;
}[];
/**
* @description The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.
* If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.
*/
- readonly base_tree?: string;
+ base_tree?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-tree"];
+ "application/json": components["schemas"]["git-tree"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "git/get-tree": {
- readonly parameters: {
- readonly query?: {
+ "git/get-tree": {
+ parameters: {
+ query?: {
/** @description Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `"true"`, and `"false"`. Omit this parameter to prevent recursively returning objects or subtrees. */
- readonly recursive?: string;
+ recursive?: string;
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The SHA1 value or ref (branch or tag) name of the tree. */
- readonly tree_sha: string;
+ tree_sha: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["git-tree"];
+ "application/json": components["schemas"]["git-tree"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 409: components["responses"]["conflict"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 409: components["responses"]["conflict"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/list-webhooks": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-webhooks": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["hook"][];
+ "application/json": components["schemas"]["hook"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/create-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`. */
- readonly name?: string;
+ name?: string;
/** @description Key/value pairs to provide settings for this webhook. */
- readonly config?: {
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ config?: {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
};
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for.
@@ -110474,1739 +117950,2029 @@ export interface operations {
* "push"
* ]
*/
- readonly events?: readonly string[];
+ events?: string[];
/**
* @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
* @default true
*/
- readonly active?: boolean;
+ active?: boolean;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/hooks/12345678 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["hook"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["hook"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/update-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- readonly config?: components["schemas"]["webhook-config"];
+ requestBody: {
+ content: {
+ "application/json": {
+ config?: components["schemas"]["webhook-config"];
/**
* @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
* @default [
* "push"
* ]
*/
- readonly events?: readonly string[];
+ events?: string[];
/** @description Determines a list of events to be added to the list of events that the Hook triggers for. */
- readonly add_events?: readonly string[];
+ add_events?: string[];
/** @description Determines a list of events to be removed from the list of events that the Hook triggers for. */
- readonly remove_events?: readonly string[];
+ remove_events?: string[];
/**
* @description Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
* @default true
*/
- readonly active?: boolean;
+ active?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook"];
+ "application/json": components["schemas"]["hook"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-webhook-config-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-webhook-config-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "repos/update-webhook-config-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-webhook-config-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- readonly url?: components["schemas"]["webhook-config-url"];
- readonly content_type?: components["schemas"]["webhook-config-content-type"];
- readonly secret?: components["schemas"]["webhook-config-secret"];
- readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
+ requestBody?: {
+ content: {
+ "application/json": {
+ url?: components["schemas"]["webhook-config-url"];
+ content_type?: components["schemas"]["webhook-config-content-type"];
+ secret?: components["schemas"]["webhook-config-secret"];
+ insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["webhook-config"];
+ "application/json": components["schemas"]["webhook-config"];
};
};
};
};
- readonly "repos/list-webhook-deliveries": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-webhook-deliveries": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */
- readonly cursor?: components["parameters"]["cursor"];
+ cursor?: components["parameters"]["cursor"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["hook-delivery-item"][];
+ "application/json": components["schemas"]["hook-delivery-item"][];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
- readonly delivery_id: components["parameters"]["delivery-id"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["hook-delivery"];
+ "application/json": components["schemas"]["hook-delivery"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/redeliver-webhook-delivery": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/redeliver-webhook-delivery": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
- readonly delivery_id: components["parameters"]["delivery-id"];
+ hook_id: components["parameters"]["hook-id"];
+ delivery_id: components["parameters"]["delivery-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
- readonly 202: components["responses"]["accepted"];
- readonly 400: components["responses"]["bad_request"];
- readonly 422: components["responses"]["validation_failed"];
+ requestBody?: never;
+ responses: {
+ 202: components["responses"]["accepted"];
+ 400: components["responses"]["bad_request"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/ping-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/ping-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/test-push-webhook": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/test-push-webhook": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */
- readonly hook_id: components["parameters"]["hook-id"];
+ hook_id: components["parameters"]["hook-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "migrations/get-import-status": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/check-immutable-releases": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
+ /** @description Response if immutable releases are enabled */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["check-immutable-releases"];
+ };
+ };
+ /** @description Not Found if immutable releases are not enabled for the repository */
+ 404: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ };
+ };
+ "repos/enable-immutable-releases": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 204: components["responses"]["no_content"];
+ 409: components["responses"]["conflict"];
+ };
+ };
+ "repos/disable-immutable-releases": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ 204: components["responses"]["no_content"];
+ 409: components["responses"]["conflict"];
+ };
+ };
+ "migrations/get-import-status": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["import"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["porter_maintenance"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/start-import": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/start-import": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The URL of the originating repository. */
- readonly vcs_url: string;
+ vcs_url: string;
/**
* @description The originating VCS type. Without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.
* @enum {string}
*/
- readonly vcs?: "subversion" | "git" | "mercurial" | "tfvc";
+ vcs?: "subversion" | "git" | "mercurial" | "tfvc";
/** @description If authentication is required, the username to provide to `vcs_url`. */
- readonly vcs_username?: string;
+ vcs_username?: string;
/** @description If authentication is required, the password to provide to `vcs_url`. */
- readonly vcs_password?: string;
+ vcs_password?: string;
/** @description For a tfvc import, the name of the project that is being imported. */
- readonly tfvc_project?: string;
+ tfvc_project?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/spraints/socm/import */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["import"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["porter_maintenance"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/cancel-import": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/cancel-import": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 503: components["responses"]["porter_maintenance"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/update-import": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/update-import": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The username to provide to the originating repository. */
- readonly vcs_username?: string;
+ vcs_username?: string;
/** @description The password to provide to the originating repository. */
- readonly vcs_password?: string;
+ vcs_password?: string;
/**
* @description The type of version control system you are migrating from.
* @example "git"
* @enum {string}
*/
- readonly vcs?: "subversion" | "tfvc" | "git" | "mercurial";
+ vcs?: "subversion" | "tfvc" | "git" | "mercurial";
/**
* @description For a tfvc import, the name of the project that is being imported.
* @example "project1"
*/
- readonly tfvc_project?: string;
+ tfvc_project?: string;
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["import"];
};
};
- readonly 503: components["responses"]["porter_maintenance"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/get-commit-authors": {
- readonly parameters: {
- readonly query?: {
+ "migrations/get-commit-authors": {
+ parameters: {
+ query?: {
/** @description A user ID. Only return users with an ID greater than this ID. */
- readonly since?: components["parameters"]["since-user"];
+ since?: components["parameters"]["since-user"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["porter-author"][];
+ "application/json": components["schemas"]["porter-author"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 503: components["responses"]["porter_maintenance"];
+ 404: components["responses"]["not_found"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/map-commit-author": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/map-commit-author": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly author_id: number;
+ repo: components["parameters"]["repo"];
+ author_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The new Git author email. */
- readonly email?: string;
+ email?: string;
/** @description The new Git author name. */
- readonly name?: string;
+ name?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["porter-author"];
+ "application/json": components["schemas"]["porter-author"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["porter_maintenance"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/get-large-files": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/get-large-files": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["porter-large-file"][];
+ "application/json": components["schemas"]["porter-large-file"][];
};
};
- readonly 503: components["responses"]["porter_maintenance"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "migrations/set-lfs-preference": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "migrations/set-lfs-preference": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description Whether to store large files during the import. `opt_in` means large files will be stored using Git LFS. `opt_out` means large files will be removed during the import.
* @enum {string}
*/
- readonly use_lfs: "opt_in" | "opt_out";
+ use_lfs: "opt_in" | "opt_out";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["import"];
+ "application/json": components["schemas"]["import"];
};
};
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["porter_maintenance"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["porter_maintenance"];
};
};
- readonly "apps/get-repo-installation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "apps/get-repo-installation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["installation"];
+ "application/json": components["schemas"]["installation"];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "interactions/get-restrictions-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/get-restrictions-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["interaction-limit-response"] | Record;
+ "application/json": components["schemas"]["interaction-limit-response"] | Record;
};
};
};
};
- readonly "interactions/set-restrictions-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/set-restrictions-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": components["schemas"]["interaction-limit"];
+ requestBody: {
+ content: {
+ "application/json": components["schemas"]["interaction-limit"];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["interaction-limit-response"];
+ "application/json": components["schemas"]["interaction-limit-response"];
};
};
/** @description Response */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "interactions/remove-restrictions-for-repo": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "interactions/remove-restrictions-for-repo": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response */
- readonly 409: {
+ 409: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/list-invitations": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-invitations": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["repository-invitation"][];
+ "application/json": components["schemas"]["repository-invitation"][];
};
};
};
};
- readonly "repos/delete-invitation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-invitation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the invitation. */
- readonly invitation_id: components["parameters"]["invitation-id"];
+ invitation_id: components["parameters"]["invitation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "repos/update-invitation": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/update-invitation": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the invitation. */
- readonly invitation_id: components["parameters"]["invitation-id"];
+ invitation_id: components["parameters"]["invitation-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.
* @enum {string}
*/
- readonly permissions?: "read" | "write" | "maintain" | "triage" | "admin";
+ permissions?: "read" | "write" | "maintain" | "triage" | "admin";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["repository-invitation"];
+ "application/json": components["schemas"]["repository-invitation"];
};
};
};
};
- readonly "issues/list-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-for-repo": {
+ parameters: {
+ query?: {
/** @description If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. */
- readonly milestone?: string;
+ milestone?: string;
/** @description Indicates the state of the issues to return. */
- readonly state?: "open" | "closed" | "all";
+ state?: "open" | "closed" | "all";
/** @description Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. */
- readonly assignee?: string;
+ assignee?: string;
+ /** @description Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned. */
+ type?: string;
/** @description The user that created the issue. */
- readonly creator?: string;
+ creator?: string;
/** @description A user that's mentioned in the issue. */
- readonly mentioned?: string;
+ mentioned?: string;
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
- readonly labels?: components["parameters"]["labels"];
+ labels?: components["parameters"]["labels"];
/** @description What to sort results by. */
- readonly sort?: "created" | "updated" | "comments";
+ sort?: "created" | "updated" | "comments";
/** @description The direction to sort the results by. */
- readonly direction?: components["parameters"]["direction"];
+ direction?: components["parameters"]["direction"];
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/create": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/create": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The title of the issue. */
- readonly title: string | number;
+ title: string | number;
/** @description The contents of the issue. */
- readonly body?: string;
+ body?: string;
/** @description Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is closing down.**_ */
- readonly assignee?: string | null;
- readonly milestone?: (string | number) | null;
+ assignee?: string | null;
+ milestone?: (string | number) | null;
/** @description Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._ */
- readonly labels?: readonly (string | {
- readonly id?: number;
- readonly name?: string;
- readonly description?: string | null;
- readonly color?: string | null;
+ labels?: (string | {
+ id?: number;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
})[];
/** @description Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ */
- readonly assignees?: readonly string[];
+ assignees?: string[];
+ /**
+ * @description The name of the issue type to associate with this issue. _NOTE: Only users with push access can set the type for new issues. The type is silently dropped otherwise._
+ * @example Epic
+ */
+ type?: string | null;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/issues/1347 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["service_unavailable"];
+ 400: components["responses"]["bad_request"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "issues/list-comments-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-comments-for-repo": {
+ parameters: {
+ query?: {
/** @description The property to sort the results by. */
- readonly sort?: components["parameters"]["sort"];
+ sort?: components["parameters"]["sort"];
/** @description Either `asc` or `desc`. Ignored without the `sort` parameter. */
- readonly direction?: "asc" | "desc";
+ direction?: "asc" | "desc";
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue-comment"][];
+ "application/json": components["schemas"]["issue-comment"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/get-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/get-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue-comment"];
+ "application/json": components["schemas"]["issue-comment"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "issues/delete-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/delete-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/update-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/update-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The contents of the comment. */
- readonly body: string;
+ body: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue-comment"];
+ "application/json": components["schemas"]["issue-comment"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/list-for-issue-comment": {
- readonly parameters: {
- readonly query?: {
+ "issues/pin-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The unique identifier of the comment. */
+ comment_id: components["parameters"]["comment-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue-comment"];
+ };
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "issues/unpin-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The unique identifier of the comment. */
+ comment_id: components["parameters"]["comment-id"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 204: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content?: never;
+ };
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 503: components["responses"]["service_unavailable"];
+ };
+ };
+ "reactions/list-for-issue-comment": {
+ parameters: {
+ query?: {
/** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */
- readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "reactions/create-for-issue-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/create-for-issue-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue comment.
* @enum {string}
*/
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
};
};
};
- readonly responses: {
+ responses: {
/** @description Reaction exists */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
/** @description Reaction created */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/delete-for-issue-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/delete-for-issue-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the comment. */
- readonly comment_id: components["parameters"]["comment-id"];
+ comment_id: components["parameters"]["comment-id"];
/** @description The unique identifier of the reaction. */
- readonly reaction_id: components["parameters"]["reaction-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/list-events-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-events-for-repo": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue-event"][];
+ "application/json": components["schemas"]["issue-event"][];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/get-event": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/get-event": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly event_id: number;
+ repo: components["parameters"]["repo"];
+ event_id: number;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue-event"];
+ "application/json": components["schemas"]["issue-event"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/get": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/get": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: {
+ content: {
+ "application/json": unknown;
};
- readonly cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 304: components["responses"]["not_modified"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 301: components["responses"]["moved_permanently"];
+ 304: components["responses"]["not_modified"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/update": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/update": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The title of the issue. */
- readonly title?: (string | number) | null;
+ title?: (string | number) | null;
/** @description The contents of the issue. */
- readonly body?: string | null;
+ body?: string | null;
/** @description Username to assign to this issue. **This field is closing down.** */
- readonly assignee?: string | null;
+ assignee?: string | null;
/**
* @description The open or closed state of the issue.
* @enum {string}
*/
- readonly state?: "open" | "closed";
+ state?: "open" | "closed";
/**
* @description The reason for the state change. Ignored unless `state` is changed.
* @example not_planned
* @enum {string|null}
*/
- readonly state_reason?: "completed" | "not_planned" | "reopened" | null;
- readonly milestone?: (string | number) | null;
+ state_reason?: "completed" | "not_planned" | "duplicate" | "reopened" | null;
+ milestone?: (string | number) | null;
/** @description Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. */
- readonly labels?: readonly (string | {
- readonly id?: number;
- readonly name?: string;
- readonly description?: string | null;
- readonly color?: string | null;
+ labels?: (string | {
+ id?: number;
+ name?: string;
+ description?: string | null;
+ color?: string | null;
})[];
/** @description Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. */
- readonly assignees?: readonly string[];
+ assignees?: string[];
+ /**
+ * @description The name of the issue type to associate with this issue or use `null` to remove the current issue type. Only users with push access can set the type for issues. Without push access to the repository, type changes are silently dropped.
+ * @example Epic
+ */
+ type?: string | null;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
- readonly 503: components["responses"]["service_unavailable"];
+ 301: components["responses"]["moved_permanently"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "issues/add-assignees": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/add-assignees": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ */
- readonly assignees?: readonly string[];
+ assignees?: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
};
};
- readonly "issues/remove-assignees": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/remove-assignees": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ */
- readonly assignees?: readonly string[];
+ assignees?: string[];
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
};
};
- readonly "issues/check-user-can-be-assigned-to-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/check-user-can-be-assigned-to-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
- readonly assignee: string;
+ issue_number: components["parameters"]["issue-number"];
+ assignee: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response if `assignee` can be assigned to `issue_number` */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
/** @description Response if `assignee` can not be assigned to `issue_number` */
- readonly 404: {
+ 404: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["basic-error"];
+ "application/json": components["schemas"]["basic-error"];
};
};
};
};
- readonly "issues/list-comments": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-comments": {
+ parameters: {
+ query?: {
/** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */
- readonly since?: components["parameters"]["since"];
+ since?: components["parameters"]["since"];
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue-comment"][];
+ "application/json": components["schemas"]["issue-comment"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/create-comment": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/create-comment": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The contents of the comment. */
- readonly body: string;
+ body: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue-comment"];
+ "application/json": components["schemas"]["issue-comment"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/list-events": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-dependencies-blocked-by": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue-event-for-issue"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 410: components["responses"]["gone"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/list-labels-on-issue": {
- readonly parameters: {
- readonly query?: {
+ "issues/add-blocked-by-dependency": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The number that identifies the issue. */
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The id of the issue that blocks the current issue */
+ issue_id: number;
+ };
+ };
+ };
+ responses: {
+ /** @description Response */
+ 201: {
+ headers: {
+ /** @example https://api.github.com/repos/octocat/Hello-World/issues/1/dependencies/blocked_by */
+ Location?: string;
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue"];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
+ };
+ };
+ "issues/remove-dependency-blocked-by": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The number that identifies the issue. */
+ issue_number: components["parameters"]["issue-number"];
+ /** @description The id of the blocking issue to remove as a dependency */
+ issue_id: number;
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue"];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
+ 400: components["responses"]["bad_request"];
+ 401: components["responses"]["requires_authentication"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ };
+ };
+ "issues/list-dependencies-blocking": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["label"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/set-labels": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/list-events": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue-event-for-issue"][];
+ };
};
- readonly cookie?: never;
+ 410: components["responses"]["gone"];
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ };
+ "issues/list-labels-on-issue": {
+ parameters: {
+ query?: {
+ /** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ per_page?: components["parameters"]["per-page"];
+ /** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
+ page?: components["parameters"]["page"];
+ };
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The number that identifies the issue. */
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["label"][];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ };
+ };
+ "issues/set-labels": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The number that identifies the issue. */
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/rest/issues/labels#add-labels-to-an-issue)." */
- readonly labels?: readonly string[];
- } | readonly string[] | {
- readonly labels?: readonly {
- readonly name: string;
+ labels?: string[];
+ } | string[] | {
+ labels?: {
+ name: string;
}[];
- } | readonly {
- readonly name: string;
+ } | {
+ name: string;
}[] | string;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["label"][];
+ "application/json": components["schemas"]["label"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/add-labels": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/add-labels": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
- };
- readonly cookie?: never;
- };
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
- /** @description The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */
- readonly labels?: readonly string[];
- } | readonly string[] | {
- readonly labels?: readonly {
- readonly name: string;
- }[];
- } | readonly {
- readonly name: string;
- }[] | string;
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: {
+ content: {
+ "application/json": {
+ /** @description The names of the labels to add to the issue's existing labels. You can also pass an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. To replace all of the labels for an issue, use "[Set labels for an issue](https://docs.github.com/rest/issues/labels#set-labels-for-an-issue)." */
+ labels?: string[];
+ } | string[] | {
+ name: string;
+ }[];
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["label"][];
+ "application/json": components["schemas"]["label"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/remove-all-labels": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/remove-all-labels": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/remove-label": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/remove-label": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
- readonly name: string;
+ issue_number: components["parameters"]["issue-number"];
+ name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["label"][];
+ "application/json": components["schemas"]["label"][];
};
};
- readonly 301: components["responses"]["moved_permanently"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/lock": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/lock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/**
* @description The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons:
* * `off-topic`
@@ -112215,9215 +119981,8547 @@ export interface operations {
* * `spam`
* @enum {string}
*/
- readonly lock_reason?: "off-topic" | "too heated" | "resolved" | "spam";
+ lock_reason?: "off-topic" | "too heated" | "resolved" | "spam";
} | null;
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/unlock": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/unlock": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ };
+ };
+ "issues/get-parent": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
+ /** @description The account owner of the repository. The name is not case sensitive. */
+ owner: components["parameters"]["owner"];
+ /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
+ repo: components["parameters"]["repo"];
+ /** @description The number that identifies the issue. */
+ issue_number: components["parameters"]["issue-number"];
+ };
+ cookie?: never;
+ };
+ requestBody?: never;
+ responses: {
+ /** @description Response */
+ 200: {
+ headers: {
+ [name: string]: unknown;
+ };
+ content: {
+ "application/json": components["schemas"]["issue"];
+ };
+ };
+ 301: components["responses"]["moved_permanently"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "reactions/list-for-issue": {
- readonly parameters: {
- readonly query?: {
+ "reactions/list-for-issue": {
+ parameters: {
+ query?: {
/** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */
- readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["reaction"][];
+ "application/json": components["schemas"]["reaction"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "reactions/create-for-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/create-for-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/**
* @description The [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions) to add to the issue.
* @enum {string}
*/
- readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
+ content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes";
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["reaction"];
+ "application/json": components["schemas"]["reaction"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "reactions/delete-for-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "reactions/delete-for-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
/** @description The unique identifier of the reaction. */
- readonly reaction_id: components["parameters"]["reaction-id"];
+ reaction_id: components["parameters"]["reaction-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/remove-sub-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/remove-sub-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The id of the sub-issue to remove */
- readonly sub_issue_id: number;
+ sub_issue_id: number;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 400: components["responses"]["bad_request"];
- readonly 404: components["responses"]["not_found"];
+ 400: components["responses"]["bad_request"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "issues/list-sub-issues": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-sub-issues": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["issue"][];
+ "application/json": components["schemas"]["issue"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "issues/add-sub-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/add-sub-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
- /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository as the parent issue */
- readonly sub_issue_id: number;
+ requestBody: {
+ content: {
+ "application/json": {
+ /** @description The id of the sub-issue to add. The sub-issue must belong to the same repository owner as the parent issue */
+ sub_issue_id: number;
/** @description Option that, when true, instructs the operation to replace the sub-issues current parent issue */
- readonly replace_parent?: boolean;
+ replace_parent?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
- readonly 422: components["responses"]["validation_failed"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/reprioritize-sub-issue": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/reprioritize-sub-issue": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The id of the sub-issue to reprioritize */
- readonly sub_issue_id: number;
+ sub_issue_id: number;
/** @description The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). */
- readonly after_id?: number;
+ after_id?: number;
/** @description The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). */
- readonly before_id?: number;
+ before_id?: number;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["issue"];
+ "application/json": components["schemas"]["issue"];
};
};
- readonly 403: components["responses"]["forbidden"];
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed_simple"];
- readonly 503: components["responses"]["service_unavailable"];
+ 403: components["responses"]["forbidden"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed_simple"];
+ 503: components["responses"]["service_unavailable"];
};
};
- readonly "issues/list-events-for-timeline": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-events-for-timeline": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The number that identifies the issue. */
- readonly issue_number: components["parameters"]["issue-number"];
+ issue_number: components["parameters"]["issue-number"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["timeline-issue-events"][];
+ "application/json": components["schemas"]["timeline-issue-events"][];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 410: components["responses"]["gone"];
+ 404: components["responses"]["not_found"];
+ 410: components["responses"]["gone"];
};
};
- readonly "repos/list-deploy-keys": {
- readonly parameters: {
- readonly query?: {
+ "repos/list-deploy-keys": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["deploy-key"][];
+ "application/json": components["schemas"]["deploy-key"][];
};
};
};
};
- readonly "repos/create-deploy-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/create-deploy-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description A name for the key. */
- readonly title?: string;
+ title?: string;
/** @description The contents of the key. */
- readonly key: string;
+ key: string;
/**
* @description If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write.
*
* Deploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see "[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)" and "[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/)."
*/
- readonly read_only?: boolean;
+ read_only?: boolean;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/keys/1 */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deploy-key"];
+ "application/json": components["schemas"]["deploy-key"];
};
};
- readonly 422: components["responses"]["validation_failed"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "repos/get-deploy-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/get-deploy-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the key. */
- readonly key_id: components["parameters"]["key-id"];
+ key_id: components["parameters"]["key-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["deploy-key"];
+ "application/json": components["schemas"]["deploy-key"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "repos/delete-deploy-key": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/delete-deploy-key": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
/** @description The unique identifier of the key. */
- readonly key_id: components["parameters"]["key-id"];
+ key_id: components["parameters"]["key-id"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/list-labels-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "issues/list-labels-for-repo": {
+ parameters: {
+ query?: {
/** @description The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly per_page?: components["parameters"]["per-page"];
+ per_page?: components["parameters"]["per-page"];
/** @description The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." */
- readonly page?: components["parameters"]["page"];
+ page?: components["parameters"]["page"];
};
- readonly header?: never;
- readonly path: {
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly Link: components["headers"]["link"];
- readonly [name: string]: unknown;
+ Link: components["headers"]["link"];
+ [name: string]: unknown;
};
content: {
- readonly "application/json": readonly components["schemas"]["label"][];
+ "application/json": components["schemas"]["label"][];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "issues/create-label": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/create-label": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody: {
- readonly content: {
- readonly "application/json": {
+ requestBody: {
+ content: {
+ "application/json": {
/** @description The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
- readonly name: string;
+ name: string;
/** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
- readonly color?: string;
+ color?: string;
/** @description A short description of the label. Must be 100 characters or fewer. */
- readonly description?: string;
+ description?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 201: {
+ 201: {
headers: {
/** @example https://api.github.com/repos/octocat/Hello-World/labels/bug */
- readonly Location?: string;
- readonly [name: string]: unknown;
+ Location?: string;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["label"];
+ "application/json": components["schemas"]["label"];
};
};
- readonly 404: components["responses"]["not_found"];
- readonly 422: components["responses"]["validation_failed"];
+ 404: components["responses"]["not_found"];
+ 422: components["responses"]["validation_failed"];
};
};
- readonly "issues/get-label": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/get-label": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly name: string;
+ repo: components["parameters"]["repo"];
+ name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["label"];
+ "application/json": components["schemas"]["label"];
};
};
- readonly 404: components["responses"]["not_found"];
+ 404: components["responses"]["not_found"];
};
};
- readonly "issues/delete-label": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/delete-label": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly name: string;
+ repo: components["parameters"]["repo"];
+ name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 204: {
+ 204: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content?: never;
};
};
};
- readonly "issues/update-label": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "issues/update-label": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
- readonly name: string;
+ repo: components["parameters"]["repo"];
+ name: string;
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: {
- readonly content: {
- readonly "application/json": {
+ requestBody?: {
+ content: {
+ "application/json": {
/** @description The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." */
- readonly new_name?: string;
+ new_name?: string;
/** @description The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */
- readonly color?: string;
+ color?: string;
/** @description A short description of the label. Must be 100 characters or fewer. */
- readonly description?: string;
+ description?: string;
};
};
};
- readonly responses: {
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["label"];
+ "application/json": components["schemas"]["label"];
};
};
};
};
- readonly "repos/list-languages": {
- readonly parameters: {
- readonly query?: never;
- readonly header?: never;
- readonly path: {
+ "repos/list-languages": {
+ parameters: {
+ query?: never;
+ header?: never;
+ path: {
/** @description The account owner of the repository. The name is not case sensitive. */
- readonly owner: components["parameters"]["owner"];
+ owner: components["parameters"]["owner"];
/** @description The name of the repository without the `.git` extension. The name is not case sensitive. */
- readonly repo: components["parameters"]["repo"];
+ repo: components["parameters"]["repo"];
};
- readonly cookie?: never;
+ cookie?: never;
};
- readonly requestBody?: never;
- readonly responses: {
+ requestBody?: never;
+ responses: {
/** @description Response */
- readonly 200: {
+ 200: {
headers: {
- readonly [name: string]: unknown;
+ [name: string]: unknown;
};
content: {
- readonly "application/json": components["schemas"]["language"];
+ "application/json": components["schemas"]["language"];
};
};
};
};
- readonly "licenses/get-for-repo": {
- readonly parameters: {
- readonly query?: {
+ "licenses/get-for-repo": {
+ parameters: {
+ query?: {
/** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply `