Field repository was removed from object type UserNamespaceRepository
The repository owned by an enterprise managed user.
", - "type": "RepositoryInfo", - "id": "repositoryinfo", - "kind": "interfaces", - "href": "/graphql/reference/interfaces#repositoryinfo" } ] }, diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 9404e73ef236..93e5a4bd900a 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -64258,11 +64258,6 @@ type UserNamespaceRepository implements Node { The user owner of the repository. """ owner: RepositoryOwner! - - """ - The repository owned by an enterprise managed user. - """ - repository: RepositoryInfo } """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index 2b8416588991..778f626aa721 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -79485,14 +79485,6 @@ "id": "repositoryowner", "kind": "interfaces", "href": "/graphql/reference/interfaces#repositoryowner" - }, - { - "name": "repository", - "description": "The repository owned by an enterprise managed user.
", - "type": "RepositoryInfo", - "id": "repositoryinfo", - "kind": "interfaces", - "href": "/graphql/reference/interfaces#repositoryinfo" } ] }, diff --git a/src/graphql/data/ghes-3.16/graphql_upcoming_changes.public-enterprise.yml b/src/graphql/data/ghes-3.16/graphql_upcoming_changes.public-enterprise.yml index 58a7dabb311a..53edf3e4c7bd 100644 --- a/src/graphql/data/ghes-3.16/graphql_upcoming_changes.public-enterprise.yml +++ b/src/graphql/data/ghes-3.16/graphql_upcoming_changes.public-enterprise.yml @@ -544,3 +544,75 @@ upcoming_changes: date: '2025-01-01T00:00:00+00:00' criticality: breaking owner: chriskirkland + - location: Enterprise.members.hasTwoFactorEnabled + description: + '`hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` + instead.' + reason: '`has_two_factor_enabled` will be removed.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: authentication + - location: EnterpriseOwnerInfo.admins.hasTwoFactorEnabled + description: + '`hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` + instead.' + reason: '`has_two_factor_enabled` will be removed.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: authentication + - location: EnterpriseOwnerInfo.outsideCollaborators.hasTwoFactorEnabled + description: + '`hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` + instead.' + reason: '`has_two_factor_enabled` will be removed.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: authentication + - location: ProjectV2.databaseId + description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' + reason: + '`databaseId` will be removed because it does not support 64-bit signed + integer identifiers.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: dewski + - location: ProjectV2Item.databaseId + description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' + reason: + '`databaseId` will be removed because it does not support 64-bit signed + integer identifiers.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: dewski + - location: ProjectV2StatusUpdate.databaseId + description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' + reason: + '`databaseId` will be removed because it does not support 64-bit signed + integer identifiers.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: dewski + - location: ProjectV2View.databaseId + description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' + reason: + '`databaseId` will be removed because it does not support 64-bit signed + integer identifiers.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: dewski + - location: ProjectV2Workflow.databaseId + description: '`databaseId` will be removed. Use `fullDatabaseId` instead.' + reason: + '`databaseId` will be removed because it does not support 64-bit signed + integer identifiers.' + date: '2025-04-01T00:00:00+00:00' + criticality: breaking + owner: dewski + - location: SecurityAdvisory.cvss + description: + '`cvss` will be removed. New `cvss_severities` field will now contain + both `cvss_v3` and `cvss_v4` properties.' + reason: '`cvss` will be removed.' + date: '2025-10-01T00:00:00+00:00' + criticality: breaking + owner: github/advisory-database diff --git a/src/graphql/data/ghes-3.16/previews.json b/src/graphql/data/ghes-3.16/previews.json index fe51488c7066..0637a088a01e 100644 --- a/src/graphql/data/ghes-3.16/previews.json +++ b/src/graphql/data/ghes-3.16/previews.json @@ -1 +1 @@ -[] +[] \ No newline at end of file diff --git a/src/graphql/data/ghes-3.16/schema.docs-enterprise.graphql b/src/graphql/data/ghes-3.16/schema.docs-enterprise.graphql index d927725b0d0d..71218c0d6bcb 100644 --- a/src/graphql/data/ghes-3.16/schema.docs-enterprise.graphql +++ b/src/graphql/data/ghes-3.16/schema.docs-enterprise.graphql @@ -970,6 +970,56 @@ type AddStarPayload { starrable: Starrable } +""" +Autogenerated input type of AddSubIssue +""" +input AddSubIssueInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The id of the issue. + """ + issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) + + """ + Option to replace parent issue if one already exists + """ + replaceParent: Boolean + + """ + The id of the sub-issue. + """ + subIssueId: ID @possibleTypes(concreteTypes: ["Issue"]) + + """ + The url of the sub-issue. + """ + subIssueUrl: String +} + +""" +Autogenerated return type of AddSubIssue. +""" +type AddSubIssuePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The parent issue that the sub-issue was added to. + """ + issue: Issue + + """ + The sub-issue of the parent. + """ + subIssue: Issue +} + """ Autogenerated input type of AddUpvote """ @@ -1113,7 +1163,7 @@ type AddedToProjectEvent implements Node { """ Represents an announcement banner. """ -interface AnnouncementBanner { +interface AnnouncementBannerI { """ The text of the announcement """ @@ -7383,6 +7433,11 @@ input CreateIssueInput { """ milestoneId: ID @possibleTypes(concreteTypes: ["Milestone"]) + """ + The Node ID of the parent issue to add this new issue to + """ + parentIssueId: ID @possibleTypes(concreteTypes: ["Issue"]) + """ An array of Node IDs for projects associated with this issue. """ @@ -7971,7 +8026,7 @@ input CreateRepositoryRulesetInput { """ The global relay id of the source in which a new ruleset should be created in. """ - sourceId: ID! @possibleTypes(concreteTypes: ["Organization", "Repository"], abstractType: "RuleSource") + sourceId: ID! @possibleTypes(concreteTypes: ["Enterprise", "Organization", "Repository"], abstractType: "RuleSource") """ The target of the ruleset. @@ -8633,6 +8688,21 @@ type CrossReferencedEvent implements Node & UniformResourceLocatable { willCloseTarget: Boolean! } +""" +The Common Vulnerability Scoring System +""" +type CvssSeverities { + """ + The CVSS v3 severity associated with this advisory + """ + cvssV3: CVSS + + """ + The CVSS v4 severity associated with this advisory + """ + cvssV4: CVSS +} + """ An ISO-8601 encoded date string. """ @@ -9739,6 +9809,11 @@ type DeployKey implements Node { """ createdAt: DateTime! + """ + Whether or not the deploy key is enabled by policy at the Enterprise or Organization level. + """ + enabled: Boolean! + """ The Node ID of the DeployKey object """ @@ -12027,6 +12102,21 @@ input DraftPullRequestReviewThread { startSide: DiffSide = RIGHT } +""" +The Exploit Prediction Scoring System +""" +type EPSS { + """ + The EPSS percentage represents the likelihood of a CVE being exploited. + """ + percentage: Float + + """ + The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + """ + percentile: Float +} + """ Autogenerated input type of EnablePullRequestAutoMerge """ @@ -12135,7 +12225,7 @@ type EnqueuePullRequestPayload { """ An account to manage multiple organizations with consolidated policy and billing. """ -type Enterprise implements AnnouncementBanner & Node { +type Enterprise implements AnnouncementBannerI & Node { """ The text of the announcement """ @@ -12233,6 +12323,10 @@ type Enterprise implements AnnouncementBanner & Node { """ Only return members with this two-factor authentication status. Does not include members who only have an account on a GitHub Enterprise Server instance. + + **Upcoming Change on 2025-04-01 UTC** + **Description:** `hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` instead. + **Reason:** `has_two_factor_enabled` will be removed. """ hasTwoFactorEnabled: Boolean = null @@ -12260,6 +12354,12 @@ type Enterprise implements AnnouncementBanner & Node { The role of the user in the enterprise organization or server. """ role: EnterpriseUserAccountMembershipRole + + """ + Only return members with this type of two-factor authentication method. Does + not include members who only have an account on a GitHub Enterprise Server instance. + """ + twoFactorMethodSecurity: TwoFactorCredentialSecurityType = null ): EnterpriseMemberConnection! """ @@ -12679,6 +12779,21 @@ enum EnterpriseDefaultRepositoryPermissionSettingValue { WRITE } +""" +The possible values for an enabled/no policy enterprise setting. +""" +enum EnterpriseDisallowedMethodsSettingValue { + """ + The setting prevents insecure 2FA methods from being used by members of the enterprise. + """ + INSECURE + + """ + There is no policy set for preventing insecure 2FA methods from being used by members of the enterprise. + """ + NO_POLICY +} + """ An edge in a connection. """ @@ -13207,6 +13322,10 @@ type EnterpriseOwnerInfo { """ Only return administrators with this two-factor authentication status. + + **Upcoming Change on 2025-04-01 UTC** + **Description:** `hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` instead. + **Reason:** `has_two_factor_enabled` will be removed. """ hasTwoFactorEnabled: Boolean = null @@ -13234,6 +13353,11 @@ type EnterpriseOwnerInfo { The role to filter by. """ role: EnterpriseAdministratorRole + + """ + Only return outside collaborators with this type of two-factor authentication method. + """ + twoFactorMethodSecurity: TwoFactorCredentialSecurityType = null ): EnterpriseAdministratorConnection! """ @@ -13841,6 +13965,10 @@ type EnterpriseOwnerInfo { """ Only return outside collaborators with this two-factor authentication status. + + **Upcoming Change on 2025-04-01 UTC** + **Description:** `hasTwoFactorEnabled` will be removed. Use `two_factor_method_security` instead. + **Reason:** `has_two_factor_enabled` will be removed. """ hasTwoFactorEnabled: Boolean = null @@ -13869,6 +13997,11 @@ type EnterpriseOwnerInfo { """ query: String + """ + Only return outside collaborators with this type of two-factor authentication method. + """ + twoFactorMethodSecurity: TwoFactorCredentialSecurityType = null + """ Only return outside collaborators on repositories with this visibility. """ @@ -13990,6 +14123,46 @@ type EnterpriseOwnerInfo { query: String ): EnterprisePendingMemberInvitationConnection! + """ + The setting value for whether deploy keys are enabled for repositories in organizations in this enterprise. + """ + repositoryDeployKeySetting: EnterpriseEnabledDisabledSettingValue! + + """ + A list of enterprise organizations configured with the provided deploy keys setting value. + """ + repositoryDeployKeySettingOrganizations( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Ordering options for organizations with this setting. + """ + orderBy: OrganizationOrder = {field: LOGIN, direction: ASC} + + """ + The setting value to find organizations for. + """ + value: Boolean! + ): OrganizationConnection! + """ The setting value for whether repository projects are enabled in this enterprise. """ @@ -14110,6 +14283,11 @@ type EnterpriseOwnerInfo { value: Boolean! ): OrganizationConnection! + """ + The setting value for what methods of two-factor authentication the enterprise prevents its users from having. + """ + twoFactorDisallowedMethodsSetting: EnterpriseDisallowedMethodsSettingValue! + """ The setting value for whether the enterprise requires two-factor authentication for its organizations and users. """ @@ -15451,8 +15629,7 @@ input FileDeletion { } """ -Prevent commits that include files with specified file extensions from being -pushed to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include files with specified file extensions from being pushed to the commit graph. """ type FileExtensionRestrictionParameters { """ @@ -15462,8 +15639,7 @@ type FileExtensionRestrictionParameters { } """ -Prevent commits that include files with specified file extensions from being -pushed to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include files with specified file extensions from being pushed to the commit graph. """ input FileExtensionRestrictionParametersInput { """ @@ -15473,8 +15649,7 @@ input FileExtensionRestrictionParametersInput { } """ -Prevent commits that include changes in specified file paths from being pushed -to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include changes in specified file paths from being pushed to the commit graph. """ type FilePathRestrictionParameters { """ @@ -15484,8 +15659,7 @@ type FilePathRestrictionParameters { } """ -Prevent commits that include changes in specified file paths from being pushed -to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include changes in specified file paths from being pushed to the commit graph. """ input FilePathRestrictionParametersInput { """ @@ -17182,6 +17356,11 @@ type Issue implements Assignable & Closable & Comment & Deletable & Labelable & """ number: Int! + """ + The parent entity of the issue. + """ + parent: Issue + """ A list of Users that are participating in the Issue conversation. """ @@ -17382,6 +17561,36 @@ type Issue implements Assignable & Closable & Comment & Deletable & Labelable & """ stateReason: IssueStateReason + """ + A list of sub-issues associated with the Issue. + """ + subIssues( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): IssueConnection! + + """ + Summary of the state of an issue's sub-issues + """ + subIssuesSummary: SubIssuesSummary! + """ A list of events, comments, commits, etc. associated with the issue. """ @@ -17568,6 +17777,11 @@ enum IssueClosedStateReason { """ COMPLETED + """ + An issue that has been closed as a duplicate + """ + DUPLICATE + """ An issue that has been closed as not planned """ @@ -18051,6 +18265,11 @@ enum IssueStateReason { """ COMPLETED + """ + An issue that has been closed as a duplicate + """ + DUPLICATE + """ An issue that has been closed as not planned """ @@ -19575,8 +19794,7 @@ type MarkedAsDuplicateEvent implements Node { } """ -Prevent commits that include file paths that exceed a specified character limit -from being pushed to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. """ type MaxFilePathLengthParameters { """ @@ -19586,8 +19804,7 @@ type MaxFilePathLengthParameters { } """ -Prevent commits that include file paths that exceed a specified character limit -from being pushed to the commit graph. NOTE: This rule is in beta and subject to change +Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. """ input MaxFilePathLengthParametersInput { """ @@ -19597,8 +19814,7 @@ input MaxFilePathLengthParametersInput { } """ -Prevent commits that exceed a specified file size limit from being pushed to the -commit. NOTE: This rule is in beta and subject to change +Prevent commits that exceed a specified file size limit from being pushed to the commit. """ type MaxFileSizeParameters { """ @@ -19608,8 +19824,7 @@ type MaxFileSizeParameters { } """ -Prevent commits that exceed a specified file size limit from being pushed to the -commit. NOTE: This rule is in beta and subject to change +Prevent commits that exceed a specified file size limit from being pushed to the commit. """ input MaxFileSizeParametersInput { """ @@ -21517,6 +21732,16 @@ type Mutation { input: AddStarInput! ): AddStarPayload + """ + Adds a sub-issue to a given issue + """ + addSubIssue( + """ + Parameters for AddSubIssue + """ + input: AddSubIssueInput! + ): AddSubIssuePayload + """ Add an upvote to a discussion or discussion comment. """ @@ -22625,6 +22850,16 @@ type Mutation { input: RemoveStarInput! ): RemoveStarPayload + """ + Removes a sub-issue from a given issue + """ + removeSubIssue( + """ + Parameters for RemoveSubIssue + """ + input: RemoveSubIssueInput! + ): RemoveSubIssuePayload + """ Remove an upvote to a discussion or discussion comment. """ @@ -22675,6 +22910,16 @@ type Mutation { input: ReorderEnvironmentInput! ): ReorderEnvironmentPayload + """ + Reprioritizes a sub-issue to a different position in the parent list. + """ + reprioritizeSubIssue( + """ + Parameters for ReprioritizeSubIssue + """ + input: ReprioritizeSubIssueInput! + ): ReprioritizeSubIssuePayload + """ Set review requests on a pull request. """ @@ -23005,6 +23250,16 @@ type Mutation { input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload + """ + Sets whether deploy keys are allowed to be created and used for an enterprise. + """ + updateEnterpriseDeployKeySetting( + """ + Parameters for UpdateEnterpriseDeployKeySetting + """ + input: UpdateEnterpriseDeployKeySettingInput! + ): UpdateEnterpriseDeployKeySettingPayload + """ Sets whether organization members with admin permissions on a repository can change repository visibility. """ @@ -23135,6 +23390,16 @@ type Mutation { input: UpdateEnterpriseTeamDiscussionsSettingInput! ): UpdateEnterpriseTeamDiscussionsSettingPayload + """ + Sets the two-factor authentication methods that users of an enterprise may not use. + """ + updateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting( + """ + Parameters for UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting + """ + input: UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput! + ): UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingPayload + """ Sets whether two factor authentication is required for all users in an enterprise. """ @@ -27104,7 +27369,7 @@ type OrgUpdateMemberRepositoryInvitationPermissionAuditEntry implements AuditEnt """ An account on GitHub, with one or more owners, that has repositories, members and teams. """ -type Organization implements Actor & AnnouncementBanner & MemberStatusable & Node & PackageOwner & ProfileOwner & ProjectOwner & ProjectV2Owner & ProjectV2Recent & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & UniformResourceLocatable { +type Organization implements Actor & AnnouncementBannerI & MemberStatusable & Node & PackageOwner & ProfileOwner & ProjectOwner & ProjectV2Owner & ProjectV2Recent & RepositoryDiscussionAuthor & RepositoryDiscussionCommentAuthor & RepositoryOwner & UniformResourceLocatable { """ The text of the announcement """ @@ -27978,6 +28243,11 @@ type Organization implements Actor & AnnouncementBanner & MemberStatusable & Nod The ID of the ruleset to be returned. """ databaseId: Int! + + """ + Include rulesets configured at higher levels that apply to this organization. + """ + includeParents: Boolean = true ): RepositoryRuleset """ @@ -28008,6 +28278,11 @@ type Organization implements Actor & AnnouncementBanner & MemberStatusable & Nod Returns the last _n_ elements from the list. """ last: Int + + """ + Return rulesets that apply to the specified target + """ + targets: [RepositoryRulesetTarget!] = null ): RepositoryRulesetConnection """ @@ -31285,6 +31560,9 @@ type ProjectV2 implements Closable & Node & Updatable { Identifies the primary key from the database. """ databaseId: Int + @deprecated( + reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2025-04-01 UTC." + ) """ A field of the project @@ -31326,6 +31604,11 @@ type ProjectV2 implements Closable & Node & Updatable { orderBy: ProjectV2FieldOrder = {field: POSITION, direction: ASC} ): ProjectV2FieldConfigurationConnection! + """ + Identifies the primary key from the database as a BigInt. + """ + fullDatabaseId: BigInt + """ The Node ID of the ProjectV2 object """ @@ -32065,6 +32348,9 @@ type ProjectV2Item implements Node { Identifies the primary key from the database. """ databaseId: Int + @deprecated( + reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2025-04-01 UTC." + ) """ The field value of the first project field which matches the 'name' argument that is set on the item. @@ -33391,6 +33677,14 @@ type ProjectV2StatusUpdate implements Node { Identifies the primary key from the database. """ databaseId: Int + @deprecated( + reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2025-04-01 UTC." + ) + + """ + Identifies the primary key from the database as a BigInt. + """ + fullDatabaseId: BigInt """ The Node ID of the ProjectV2StatusUpdate object @@ -33516,6 +33810,9 @@ type ProjectV2View implements Node { Identifies the primary key from the database. """ databaseId: Int + @deprecated( + reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2025-04-01 UTC." + ) """ The view's visible fields. @@ -33552,6 +33849,11 @@ type ProjectV2View implements Node { """ filter: String + """ + Identifies the primary key from the database as a BigInt. + """ + fullDatabaseId: BigInt + """ The view's group-by field. """ @@ -33903,12 +34205,20 @@ type ProjectV2Workflow implements Node { Identifies the primary key from the database. """ databaseId: Int + @deprecated( + reason: "`databaseId` will be removed because it does not support 64-bit signed integer identifiers. Use `fullDatabaseId` instead. Removal on 2025-04-01 UTC." + ) """ Whether the workflow is enabled. """ enabled: Boolean! + """ + Identifies the primary key from the database as a BigInt. + """ + fullDatabaseId: BigInt + """ The Node ID of the ProjectV2Workflow object """ @@ -37329,7 +37639,7 @@ type PushAllowanceEdge { """ The query root of GitHub's GraphQL interface. """ -type Query { +type Query implements Node { """ Look up a code of conduct by its key """ @@ -37360,6 +37670,11 @@ type Query { slug: String! ): Enterprise + """ + ID of the object. + """ + id: ID! + """ Look up an open source license by its key """ @@ -37554,6 +37869,16 @@ type Query { """ classifications: [SecurityAdvisoryClassification!] + """ + The EPSS percentage to filter advisories by. + """ + epssPercentage: Float + + """ + The EPSS percentile to filter advisories by. + """ + epssPercentile: Float + """ Returns the first _n_ elements from the list. """ @@ -39195,6 +39520,46 @@ type RemoveStarPayload { starrable: Starrable } +""" +Autogenerated input type of RemoveSubIssue +""" +input RemoveSubIssueInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The id of the issue. + """ + issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) + + """ + The id of the sub-issue. + """ + subIssueId: ID! @possibleTypes(concreteTypes: ["Issue"]) +} + +""" +Autogenerated return type of RemoveSubIssue. +""" +type RemoveSubIssuePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The parent of the sub-issue. + """ + issue: Issue + + """ + The sub-issue of the parent. + """ + subIssue: Issue +} + """ Autogenerated input type of RemoveUpvote """ @@ -43366,6 +43731,11 @@ type Repository implements Node & PackageOwner & ProjectOwner & ProjectV2Recent Returns the last _n_ elements from the list. """ last: Int + + """ + Return rulesets that apply to the specified target + """ + targets: [RepositoryRulesetTarget!] = null ): RepositoryRulesetConnection """ @@ -44975,14 +45345,12 @@ enum RepositoryRuleType { DELETION """ - Prevent commits that include files with specified file extensions from being - pushed to the commit graph. NOTE: This rule is in beta and subject to change + Prevent commits that include files with specified file extensions from being pushed to the commit graph. """ FILE_EXTENSION_RESTRICTION """ - Prevent commits that include changes in specified file paths from being pushed - to the commit graph. NOTE: This rule is in beta and subject to change + Prevent commits that include changes in specified file paths from being pushed to the commit graph. """ FILE_PATH_RESTRICTION @@ -44992,15 +45360,12 @@ enum RepositoryRuleType { LOCK_BRANCH """ - Prevent commits that include file paths that exceed a specified character - limit from being pushed to the commit graph. NOTE: This rule is in beta and - subject to change + Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. """ MAX_FILE_PATH_LENGTH """ - Prevent commits that exceed a specified file size limit from being pushed to - the commit. NOTE: This rule is in beta and subject to change + Prevent commits that exceed a specified file size limit from being pushed to the commit. """ MAX_FILE_SIZE @@ -45217,6 +45582,11 @@ type RepositoryRulesetBypassActor implements Node { """ deployKey: Boolean! + """ + This actor represents the ability for an enterprise owner to bypass + """ + enterpriseOwner: Boolean! + """ The Node ID of the RepositoryRulesetBypassActor object """ @@ -45319,6 +45689,11 @@ input RepositoryRulesetBypassActorInput { """ deployKey: Boolean + """ + For enterprise owner bypasses, true + """ + enterpriseOwner: Boolean + """ For organization owner bypasses, true """ @@ -45371,7 +45746,7 @@ type RepositoryRulesetEdge { } """ -The targets supported for rulesets. NOTE: The push target is in beta and subject to change. +The targets supported for rulesets. """ enum RepositoryRulesetTarget { """ @@ -45870,6 +46245,51 @@ enum RepositoryVulnerabilityAlertState { OPEN } +""" +Autogenerated input type of ReprioritizeSubIssue +""" +input ReprioritizeSubIssueInput { + """ + The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified). + """ + afterId: ID @possibleTypes(concreteTypes: ["Issue"]) + + """ + The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified). + """ + beforeId: ID @possibleTypes(concreteTypes: ["Issue"]) + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The id of the parent issue. + """ + issueId: ID! @possibleTypes(concreteTypes: ["Issue"]) + + """ + The id of the sub-issue to reprioritize. + """ + subIssueId: ID! @possibleTypes(concreteTypes: ["Issue"]) +} + +""" +Autogenerated return type of ReprioritizeSubIssue. +""" +type ReprioritizeSubIssuePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The parent issue that the sub-issue was reprioritized in. + """ + issue: Issue +} + """ Autogenerated input type of RequestReviews """ @@ -46791,7 +47211,7 @@ input RuleParametersInput { """ Types which can have `RepositoryRule` objects. """ -union RuleSource = Organization | Repository +union RuleSource = Enterprise | Organization | Repository """ The possible digest algorithms used to sign SAML requests for an identity provider. @@ -47068,6 +47488,14 @@ type SecurityAdvisory implements Node { The CVSS associated with this advisory """ cvss: CVSS! + @deprecated( + reason: "`cvss` will be removed. New `cvss_severities` field will now contain both `cvss_v3` and `cvss_v4` properties. Removal on 2025-10-01 UTC." + ) + + """ + The CVSS associated with this advisory + """ + cvssSeverities: CvssSeverities! """ CWEs associated with this Advisory @@ -47104,6 +47532,11 @@ type SecurityAdvisory implements Node { """ description: String! + """ + The Exploit Prediction Scoring System + """ + epss: EPSS + """ The GitHub Security Advisory ID """ @@ -47591,6 +48024,11 @@ type SocialAccountEdge { Software or company that hosts social media accounts. """ enum SocialAccountProvider { + """ + Decentralized microblogging social platform. + """ + BLUESKY + """ Social media and networking website. """ @@ -48335,6 +48773,26 @@ enum StatusState { SUCCESS } +""" +Summary of the state of an issue's sub-issues +""" +type SubIssuesSummary { + """ + Count of completed sub-issues + """ + completed: Int! + + """ + Percent of sub-issues which are completed + """ + percentCompleted: Int! + + """ + Count of total number of sub-issues + """ + total: Int! +} + """ Autogenerated input type of SubmitPullRequestReview """ @@ -51277,6 +51735,26 @@ type TreeEntry { type: String! } +""" +Filters by whether or not 2FA is enabled and if the method configured is considered secure or insecure. +""" +enum TwoFactorCredentialSecurityType { + """ + No method of two-factor authentication. + """ + DISABLED + + """ + Has an insecure method of two-factor authentication. GitHub currently defines this as SMS two-factor authentication. + """ + INSECURE + + """ + Has only secure methods of two-factor authentication. + """ + SECURE +} + """ An RFC 3986, RFC 3987, and RFC 6570 (level 4) compliant URI string. """ @@ -52522,6 +53000,46 @@ type UpdateEnterpriseDefaultRepositoryPermissionSettingPayload { message: String } +""" +Autogenerated input type of UpdateEnterpriseDeployKeySetting +""" +input UpdateEnterpriseDeployKeySettingInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise on which to set the deploy key setting. + """ + enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The value for the deploy key setting on the enterprise. + """ + settingValue: EnterpriseEnabledDisabledSettingValue! +} + +""" +Autogenerated return type of UpdateEnterpriseDeployKeySetting. +""" +type UpdateEnterpriseDeployKeySettingPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The enterprise with the updated deploy key setting. + """ + enterprise: Enterprise + + """ + A message confirming the result of updating the deploy key setting. + """ + message: String +} + """ Autogenerated input type of UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting """ @@ -53073,6 +53591,46 @@ type UpdateEnterpriseTeamDiscussionsSettingPayload { message: String } +""" +Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting +""" +input UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise on which to set the two-factor authentication disallowed methods setting. + """ + enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The value for the two-factor authentication disallowed methods setting on the enterprise. + """ + settingValue: EnterpriseDisallowedMethodsSettingValue! +} + +""" +Autogenerated return type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting. +""" +type UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The enterprise with the updated two-factor authentication disallowed methods setting. + """ + enterprise: Enterprise + + """ + A message confirming the result of updating the two-factor authentication disallowed methods setting. + """ + message: String +} + """ Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationRequiredSetting """ @@ -56030,6 +56588,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ url: URI! + """ + Whether the request returns publicly visible information or privately visible information about the user + """ + userViewType: UserViewType! + """ Can the viewer pin repositories and gists to the profile? """ @@ -56623,6 +57186,21 @@ enum UserStatusOrderField { UPDATED_AT } +""" +Whether a user being viewed contains public or private information. +""" +enum UserViewType { + """ + A user containing information only visible to the authenticated user. + """ + PRIVATE + + """ + A user that is publicly visible. + """ + PUBLIC +} + """ A domain that can be verified or approved for an organization or an enterprise. """ diff --git a/src/graphql/data/ghes-3.16/schema.json b/src/graphql/data/ghes-3.16/schema.json index d67cd9a88808..eeac0ce08de5 100644 --- a/src/graphql/data/ghes-3.16/schema.json +++ b/src/graphql/data/ghes-3.16/schema.json @@ -53,6 +53,15 @@ } ] }, + { + "name": "id", + "type": "ID!", + "kind": "scalars", + "id": "id", + "href": "/graphql/reference/scalars#id", + "description": "ID of the object.
", + "args": [] + }, { "name": "license", "type": "License", @@ -382,6 +391,22 @@ "href": "/graphql/reference/enums#securityadvisoryclassification", "description": "A list of classifications to filter advisories by.
" }, + { + "name": "epssPercentage", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentage to filter advisories by.
" + }, + { + "name": "epssPercentile", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentile to filter advisories by.
" + }, { "name": "first", "type": "Int", @@ -1331,6 +1356,48 @@ } ] }, + { + "name": "addSubIssue", + "kind": "mutations", + "id": "addsubissue", + "href": "/graphql/reference/mutations#addsubissue", + "description": "Adds a sub-issue to a given issue.
", + "inputFields": [ + { + "name": "input", + "type": "AddSubIssueInput!", + "id": "addsubissueinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#addsubissueinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A unique identifier for the client performing the mutation.
" + }, + { + "name": "issue", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue", + "description": "The parent issue that the sub-issue was added to.
" + }, + { + "name": "subIssue", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue", + "description": "The sub-issue of the parent.
" + } + ] + }, { "name": "addUpvote", "kind": "mutations", @@ -5067,6 +5134,48 @@ } ] }, + { + "name": "removeSubIssue", + "kind": "mutations", + "id": "removesubissue", + "href": "/graphql/reference/mutations#removesubissue", + "description": "Removes a sub-issue from a given issue.
", + "inputFields": [ + { + "name": "input", + "type": "RemoveSubIssueInput!", + "id": "removesubissueinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#removesubissueinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A unique identifier for the client performing the mutation.
" + }, + { + "name": "issue", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue", + "description": "The parent of the sub-issue.
" + }, + { + "name": "subIssue", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue", + "description": "The sub-issue of the parent.
" + } + ] + }, { "name": "removeUpvote", "kind": "mutations", @@ -5237,6 +5346,40 @@ } ] }, + { + "name": "reprioritizeSubIssue", + "kind": "mutations", + "id": "reprioritizesubissue", + "href": "/graphql/reference/mutations#reprioritizesubissue", + "description": "Reprioritizes a sub-issue to a different position in the parent list.
", + "inputFields": [ + { + "name": "input", + "type": "ReprioritizeSubIssueInput!", + "id": "reprioritizesubissueinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#reprioritizesubissueinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A unique identifier for the client performing the mutation.
" + }, + { + "name": "issue", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue", + "description": "The parent issue that the sub-issue was reprioritized in.
" + } + ] + }, { "name": "requestReviews", "kind": "mutations", @@ -6423,6 +6566,48 @@ } ] }, + { + "name": "updateEnterpriseDeployKeySetting", + "kind": "mutations", + "id": "updateenterprisedeploykeysetting", + "href": "/graphql/reference/mutations#updateenterprisedeploykeysetting", + "description": "Sets whether deploy keys are allowed to be created and used for an enterprise.
", + "inputFields": [ + { + "name": "input", + "type": "UpdateEnterpriseDeployKeySettingInput!", + "id": "updateenterprisedeploykeysettinginput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updateenterprisedeploykeysettinginput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A unique identifier for the client performing the mutation.
" + }, + { + "name": "enterprise", + "type": "Enterprise", + "id": "enterprise", + "kind": "objects", + "href": "/graphql/reference/objects#enterprise", + "description": "The enterprise with the updated deploy key setting.
" + }, + { + "name": "message", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A message confirming the result of updating the deploy key setting.
" + } + ] + }, { "name": "updateEnterpriseMembersCanChangeRepositoryVisibilitySetting", "kind": "mutations", @@ -6953,6 +7138,48 @@ } ] }, + { + "name": "updateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting", + "kind": "mutations", + "id": "updateenterprisetwofactorauthenticationdisallowedmethodssetting", + "href": "/graphql/reference/mutations#updateenterprisetwofactorauthenticationdisallowedmethodssetting", + "description": "Sets the two-factor authentication methods that users of an enterprise may not use.
", + "inputFields": [ + { + "name": "input", + "type": "UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput!", + "id": "updateenterprisetwofactorauthenticationdisallowedmethodssettinginput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#updateenterprisetwofactorauthenticationdisallowedmethodssettinginput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A unique identifier for the client performing the mutation.
" + }, + { + "name": "enterprise", + "type": "Enterprise", + "id": "enterprise", + "kind": "objects", + "href": "/graphql/reference/objects#enterprise", + "description": "The enterprise with the updated two-factor authentication disallowed methods setting.
" + }, + { + "name": "message", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "A message confirming the result of updating the two-factor authentication disallowed methods setting.
" + } + ] + }, { "name": "updateEnterpriseTwoFactorAuthenticationRequiredSetting", "kind": "mutations", @@ -16041,6 +16268,31 @@ } ] }, + { + "name": "CvssSeverities", + "kind": "objects", + "id": "cvssseverities", + "href": "/graphql/reference/objects#cvssseverities", + "description": "The Common Vulnerability Scoring System.
", + "fields": [ + { + "name": "cvssV3", + "description": "The CVSS v3 severity associated with this advisory.
", + "type": "CVSS", + "id": "cvss", + "kind": "objects", + "href": "/graphql/reference/objects#cvss" + }, + { + "name": "cvssV4", + "description": "The CVSS v4 severity associated with this advisory.
", + "type": "CVSS", + "id": "cvss", + "kind": "objects", + "href": "/graphql/reference/objects#cvss" + } + ] + }, { "name": "DemilestonedEvent", "kind": "objects", @@ -16505,6 +16757,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "enabled", + "description": "Whether or not the deploy key is enabled by policy at the Enterprise or Organization level.
", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "id", "description": "The Node ID of the DeployKey object.
", @@ -19695,6 +19955,31 @@ } ] }, + { + "name": "EPSS", + "kind": "objects", + "id": "epss", + "href": "/graphql/reference/objects#epss", + "description": "The Exploit Prediction Scoring System.
", + "fields": [ + { + "name": "percentage", + "description": "The EPSS percentage represents the likelihood of a CVE being exploited.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + }, + { + "name": "percentile", + "description": "The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + } + ] + }, { "name": "Enterprise", "kind": "objects", @@ -19703,9 +19988,9 @@ "description": "An account to manage multiple organizations with consolidated policy and billing.
", "implements": [ { - "name": "AnnouncementBanner", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner" + "name": "AnnouncementBannerI", + "id": "announcementbanneri", + "href": "/graphql/reference/interfaces#announcementbanneri" }, { "name": "Node", @@ -19880,7 +20165,7 @@ }, { "name": "hasTwoFactorEnabled", - "description": "Only return members with this two-factor authentication status. Does not\ninclude members who only have an account on a GitHub Enterprise Server instance.
", + "description": "Only return members with this two-factor authentication status. Does not\ninclude members who only have an account on a GitHub Enterprise Server instance.
\nUpcoming Change on 2025-04-01 UTC\nDescription: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.\nReason: has_two_factor_enabled will be removed.
Only return members with this type of two-factor authentication method. Does\nnot include members who only have an account on a GitHub Enterprise Server instance.
", + "type": { + "name": "TwoFactorCredentialSecurityType", + "id": "twofactorcredentialsecuritytype", + "kind": "enums", + "href": "/graphql/reference/enums#twofactorcredentialsecuritytype" + } } ] }, @@ -21072,7 +21367,7 @@ }, { "name": "hasTwoFactorEnabled", - "description": "Only return administrators with this two-factor authentication status.
", + "description": "Only return administrators with this two-factor authentication status.
\nUpcoming Change on 2025-04-01 UTC\nDescription: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.\nReason: has_two_factor_enabled will be removed.
Only return outside collaborators with this type of two-factor authentication method.
", + "type": { + "name": "TwoFactorCredentialSecurityType", + "id": "twofactorcredentialsecuritytype", + "kind": "enums", + "href": "/graphql/reference/enums#twofactorcredentialsecuritytype" + } } ] }, @@ -22290,7 +22595,7 @@ }, { "name": "hasTwoFactorEnabled", - "description": "Only return outside collaborators with this two-factor authentication status.
", + "description": "Only return outside collaborators with this two-factor authentication status.
\nUpcoming Change on 2025-04-01 UTC\nDescription: hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.\nReason: has_two_factor_enabled will be removed.
Only return outside collaborators with this type of two-factor authentication method.
", + "type": { + "name": "TwoFactorCredentialSecurityType", + "id": "twofactorcredentialsecuritytype", + "kind": "enums", + "href": "/graphql/reference/enums#twofactorcredentialsecuritytype" + } + }, { "name": "visibility", "description": "Only return outside collaborators on repositories with this visibility.
", @@ -22590,6 +22905,84 @@ } ] }, + { + "name": "repositoryDeployKeySetting", + "description": "The setting value for whether deploy keys are enabled for repositories in organizations in this enterprise.
", + "type": "EnterpriseEnabledDisabledSettingValue!", + "id": "enterpriseenableddisabledsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" + }, + { + "name": "repositoryDeployKeySettingOrganizations", + "description": "A list of enterprise organizations configured with the provided deploy keys setting value.
", + "type": "OrganizationConnection!", + "id": "organizationconnection", + "kind": "objects", + "href": "/graphql/reference/objects#organizationconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "orderBy", + "description": "Ordering options for organizations with this setting.
", + "type": { + "name": "OrganizationOrder", + "id": "organizationorder", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#organizationorder" + } + }, + { + "name": "value", + "description": "The setting value to find organizations for.
", + "type": { + "name": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } + } + ] + }, { "name": "repositoryProjectsSetting", "description": "The setting value for whether repository projects are enabled in this enterprise.
", @@ -22824,6 +23217,14 @@ } ] }, + { + "name": "twoFactorDisallowedMethodsSetting", + "description": "The setting value for what methods of two-factor authentication the enterprise prevents its users from having.
", + "type": "EnterpriseDisallowedMethodsSettingValue!", + "id": "enterprisedisallowedmethodssettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#enterprisedisallowedmethodssettingvalue" + }, { "name": "twoFactorRequiredSetting", "description": "The setting value for whether the enterprise requires two-factor authentication for its organizations and users.
", @@ -24567,7 +24968,7 @@ "kind": "objects", "id": "fileextensionrestrictionparameters", "href": "/graphql/reference/objects#fileextensionrestrictionparameters", - "description": "Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "fields": [ { "name": "restrictedFileExtensions", @@ -24584,7 +24985,7 @@ "kind": "objects", "id": "filepathrestrictionparameters", "href": "/graphql/reference/objects#filepathrestrictionparameters", - "description": "Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.
", "fields": [ { "name": "restrictedFilePaths", @@ -26696,6 +27097,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" }, + { + "name": "parent", + "description": "The parent entity of the issue.
", + "type": "Issue", + "id": "issue", + "kind": "objects", + "href": "/graphql/reference/objects#issue" + }, { "name": "participants", "description": "A list of Users that are participating in the Issue conversation.
", @@ -27086,6 +27495,64 @@ "kind": "enums", "href": "/graphql/reference/enums#issuestatereason" }, + { + "name": "subIssues", + "description": "A list of sub-issues associated with the Issue.
", + "type": "IssueConnection!", + "id": "issueconnection", + "kind": "objects", + "href": "/graphql/reference/objects#issueconnection", + "arguments": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.
", + "type": { + "name": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + }, + { + "name": "first", + "description": "Returns the first n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + }, + { + "name": "last", + "description": "Returns the last n elements from the list.
", + "type": { + "name": "Int", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + } + ] + }, + { + "name": "subIssuesSummary", + "description": "Summary of the state of an issue's sub-issues.
", + "type": "SubIssuesSummary!", + "id": "subissuessummary", + "kind": "objects", + "href": "/graphql/reference/objects#subissuessummary" + }, { "name": "timeline", "description": "A list of events, comments, commits, etc. associated with the issue.
", @@ -29497,7 +29964,7 @@ "kind": "objects", "id": "maxfilepathlengthparameters", "href": "/graphql/reference/objects#maxfilepathlengthparameters", - "description": "Prevent commits that include file paths that exceed a specified character limit\nfrom being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
", "fields": [ { "name": "maxFilePathLength", @@ -29514,7 +29981,7 @@ "kind": "objects", "id": "maxfilesizeparameters", "href": "/graphql/reference/objects#maxfilesizeparameters", - "description": "Prevent commits that exceed a specified file size limit from being pushed to the\ncommit. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.
", "fields": [ { "name": "maxFileSize", @@ -36978,9 +37445,9 @@ "href": "/graphql/reference/interfaces#actor" }, { - "name": "AnnouncementBanner", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner" + "name": "AnnouncementBannerI", + "id": "announcementbanneri", + "href": "/graphql/reference/interfaces#announcementbanneri" }, { "name": "MemberStatusable", @@ -38713,6 +39180,17 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" } + }, + { + "name": "includeParents", + "defaultValue": true, + "description": "Include rulesets configured at higher levels that apply to this organization.
", + "type": { + "name": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + } } ] }, @@ -38774,6 +39252,16 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" } + }, + { + "name": "targets", + "description": "Return rulesets that apply to the specified target.
", + "type": { + "name": "[RepositoryRulesetTarget!]", + "id": "repositoryrulesettarget", + "kind": "enums", + "href": "/graphql/reference/enums#repositoryrulesettarget" + } } ] }, @@ -42651,7 +43139,9 @@ "type": "Int", "id": "int", "kind": "scalars", - "href": "/graphql/reference/scalars#int" + "href": "/graphql/reference/scalars#int", + "isDeprecated": true, + "deprecationReason": "databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.
Identifies the primary key from the database as a BigInt.
", + "type": "BigInt", + "id": "bigint", + "kind": "scalars", + "href": "/graphql/reference/scalars#bigint" + }, { "name": "id", "description": "The Node ID of the ProjectV2 object.
", @@ -43632,7 +44130,9 @@ "type": "Int", "id": "int", "kind": "scalars", - "href": "/graphql/reference/scalars#int" + "href": "/graphql/reference/scalars#int", + "isDeprecated": true, + "deprecationReason": "databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.
databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.
Identifies the primary key from the database as a BigInt.
", + "type": "BigInt", + "id": "bigint", + "kind": "scalars", + "href": "/graphql/reference/scalars#bigint" }, { "name": "id", @@ -45430,7 +45940,9 @@ "type": "Int", "id": "int", "kind": "scalars", - "href": "/graphql/reference/scalars#int" + "href": "/graphql/reference/scalars#int", + "isDeprecated": true, + "deprecationReason": "databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.
Identifies the primary key from the database as a BigInt.
", + "type": "BigInt", + "id": "bigint", + "kind": "scalars", + "href": "/graphql/reference/scalars#bigint" + }, { "name": "groupBy", "description": "The view's group-by field.
", @@ -46052,7 +46572,9 @@ "type": "Int", "id": "int", "kind": "scalars", - "href": "/graphql/reference/scalars#int" + "href": "/graphql/reference/scalars#int", + "isDeprecated": true, + "deprecationReason": "databaseId will be removed because it does not support 64-bit signed integer identifiers. Use fullDatabaseId instead. Removal on 2025-04-01 UTC.
Identifies the primary key from the database as a BigInt.
", + "type": "BigInt", + "id": "bigint", + "kind": "scalars", + "href": "/graphql/reference/scalars#bigint" + }, { "name": "id", "description": "The Node ID of the ProjectV2Workflow object.
", @@ -59844,6 +60374,16 @@ "kind": "scalars", "href": "/graphql/reference/scalars#int" } + }, + { + "name": "targets", + "description": "Return rulesets that apply to the specified target.
", + "type": { + "name": "[RepositoryRulesetTarget!]", + "id": "repositoryrulesettarget", + "kind": "enums", + "href": "/graphql/reference/enums#repositoryrulesettarget" + } } ] }, @@ -61413,6 +61953,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "enterpriseOwner", + "description": "This actor represents the ability for an enterprise owner to bypass.
", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "id", "description": "The Node ID of the RepositoryRulesetBypassActor object.
", @@ -63301,7 +63849,17 @@ "type": "CVSS!", "id": "cvss", "kind": "objects", - "href": "/graphql/reference/objects#cvss" + "href": "/graphql/reference/objects#cvss", + "isDeprecated": true, + "deprecationReason": "cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties. Removal on 2025-10-01 UTC.
The CVSS associated with this advisory.
", + "type": "CvssSeverities!", + "id": "cvssseverities", + "kind": "objects", + "href": "/graphql/reference/objects#cvssseverities" }, { "name": "cwes", @@ -63369,6 +63927,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "epss", + "description": "The Exploit Prediction Scoring System.
", + "type": "EPSS", + "id": "epss", + "kind": "objects", + "href": "/graphql/reference/objects#epss" + }, { "name": "ghsaId", "description": "The GitHub Security Advisory ID.
", @@ -64729,6 +65295,39 @@ } ] }, + { + "name": "SubIssuesSummary", + "kind": "objects", + "id": "subissuessummary", + "href": "/graphql/reference/objects#subissuessummary", + "description": "Summary of the state of an issue's sub-issues.
", + "fields": [ + { + "name": "completed", + "description": "Count of completed sub-issues.
", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "percentCompleted", + "description": "Percent of sub-issues which are completed.
", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + }, + { + "name": "total", + "description": "Count of total number of sub-issues.
", + "type": "Int!", + "id": "int", + "kind": "scalars", + "href": "/graphql/reference/scalars#int" + } + ] + }, { "name": "Submodule", "kind": "objects", @@ -71895,6 +72494,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#uri" }, + { + "name": "userViewType", + "description": "Whether the request returns publicly visible information or privately visible information about the user.
", + "type": "UserViewType!", + "id": "userviewtype", + "kind": "enums", + "href": "/graphql/reference/enums#userviewtype" + }, { "name": "viewerCanChangePinnedItems", "description": "Can the viewer pin repositories and gists to the profile?.
", @@ -73692,10 +74299,10 @@ ] }, { - "name": "AnnouncementBanner", + "name": "AnnouncementBannerI", "kind": "interfaces", - "id": "announcementbanner", - "href": "/graphql/reference/interfaces#announcementbanner", + "id": "announcementbanneri", + "href": "/graphql/reference/interfaces#announcementbanneri", "description": "Represents an announcement banner.
", "fields": [ { @@ -77532,6 +78139,23 @@ } ] }, + { + "name": "EnterpriseDisallowedMethodsSettingValue", + "kind": "enums", + "id": "enterprisedisallowedmethodssettingvalue", + "href": "/graphql/reference/enums#enterprisedisallowedmethodssettingvalue", + "description": "The possible values for an enabled/no policy enterprise setting.
", + "values": [ + { + "name": "INSECURE", + "description": "The setting prevents insecure 2FA methods from being used by members of the enterprise.
" + }, + { + "name": "NO_POLICY", + "description": "There is no policy set for preventing insecure 2FA methods from being used by members of the enterprise.
" + } + ] + }, { "name": "EnterpriseEnabledDisabledSettingValue", "kind": "enums", @@ -78047,6 +78671,10 @@ "name": "COMPLETED", "description": "An issue that has been closed as completed.
" }, + { + "name": "DUPLICATE", + "description": "An issue that has been closed as a duplicate.
" + }, { "name": "NOT_PLANNED", "description": "An issue that has been closed as not planned.
" @@ -78115,6 +78743,10 @@ "name": "COMPLETED", "description": "An issue that has been closed as completed.
" }, + { + "name": "DUPLICATE", + "description": "An issue that has been closed as a duplicate.
" + }, { "name": "NOT_PLANNED", "description": "An issue that has been closed as not planned.
" @@ -80853,11 +81485,11 @@ }, { "name": "FILE_EXTENSION_RESTRICTION", - "description": "Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: This rule is in beta and subject to change.
" + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
" }, { "name": "FILE_PATH_RESTRICTION", - "description": "Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: This rule is in beta and subject to change.
" + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.
" }, { "name": "LOCK_BRANCH", @@ -80865,11 +81497,11 @@ }, { "name": "MAX_FILE_PATH_LENGTH", - "description": "Prevent commits that include file paths that exceed a specified character\nlimit from being pushed to the commit graph. NOTE: This rule is in beta and\nsubject to change.
" + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
" }, { "name": "MAX_FILE_SIZE", - "description": "Prevent commits that exceed a specified file size limit from being pushed to\nthe commit. NOTE: This rule is in beta and subject to change.
" + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.
" }, { "name": "MAX_REF_UPDATES", @@ -80963,7 +81595,7 @@ "kind": "enums", "id": "repositoryrulesettarget", "href": "/graphql/reference/enums#repositoryrulesettarget", - "description": "The targets supported for rulesets. NOTE: The push target is in beta and subject to change.
", + "description": "The targets supported for rulesets.
", "values": [ { "name": "BRANCH", @@ -81307,6 +81939,10 @@ "href": "/graphql/reference/enums#socialaccountprovider", "description": "Software or company that hosts social media accounts.
", "values": [ + { + "name": "BLUESKY", + "description": "Decentralized microblogging social platform.
" + }, { "name": "FACEBOOK", "description": "Social media and networking website.
" @@ -81715,6 +82351,27 @@ } ] }, + { + "name": "TwoFactorCredentialSecurityType", + "kind": "enums", + "id": "twofactorcredentialsecuritytype", + "href": "/graphql/reference/enums#twofactorcredentialsecuritytype", + "description": "Filters by whether or not 2FA is enabled and if the method configured is considered secure or insecure.
", + "values": [ + { + "name": "DISABLED", + "description": "No method of two-factor authentication.
" + }, + { + "name": "INSECURE", + "description": "Has an insecure method of two-factor authentication. GitHub currently defines this as SMS two-factor authentication.
" + }, + { + "name": "SECURE", + "description": "Has only secure methods of two-factor authentication.
" + } + ] + }, { "name": "UserBlockDuration", "kind": "enums", @@ -81757,6 +82414,23 @@ } ] }, + { + "name": "UserViewType", + "kind": "enums", + "id": "userviewtype", + "href": "/graphql/reference/enums#userviewtype", + "description": "Whether a user being viewed contains public or private information.
", + "values": [ + { + "name": "PRIVATE", + "description": "A user containing information only visible to the authenticated user.
" + }, + { + "name": "PUBLIC", + "description": "A user that is publicly visible.
" + } + ] + }, { "name": "VerifiableDomainOrderField", "kind": "enums", @@ -83640,6 +84314,11 @@ "href": "/graphql/reference/unions#rulesource", "description": "Types which can have RepositoryRule objects.
Autogenerated input type of AddSubIssue.
", + "inputFields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "issueId", + "description": "The id of the issue.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "replaceParent", + "description": "Option to replace parent issue if one already exists.
", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, + { + "name": "subIssueId", + "description": "The id of the sub-issue.
", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "subIssueUrl", + "description": "The url of the sub-issue.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "AddUpvoteInput", "kind": "inputObjects", @@ -86834,6 +87564,15 @@ "href": "/graphql/reference/scalars#id", "isDeprecated": false }, + { + "name": "parentIssueId", + "description": "The Node ID of the parent issue to add this new issue to.
", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, { "name": "projectIds", "description": "An array of Node IDs for projects associated with this issue.
", @@ -89039,7 +89778,7 @@ "kind": "inputObjects", "id": "fileextensionrestrictionparametersinput", "href": "/graphql/reference/input-objects#fileextensionrestrictionparametersinput", - "description": "Prevent commits that include files with specified file extensions from being\npushed to the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.
", "inputFields": [ { "name": "restrictedFileExtensions", @@ -89056,7 +89795,7 @@ "kind": "inputObjects", "id": "filepathrestrictionparametersinput", "href": "/graphql/reference/input-objects#filepathrestrictionparametersinput", - "description": "Prevent commits that include changes in specified file paths from being pushed\nto the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.
", "inputFields": [ { "name": "restrictedFilePaths", @@ -89791,7 +90530,7 @@ "kind": "inputObjects", "id": "maxfilepathlengthparametersinput", "href": "/graphql/reference/input-objects#maxfilepathlengthparametersinput", - "description": "Prevent commits that include file paths that exceed a specified character limit\nfrom being pushed to the commit graph. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.
", "inputFields": [ { "name": "maxFilePathLength", @@ -89808,7 +90547,7 @@ "kind": "inputObjects", "id": "maxfilesizeparametersinput", "href": "/graphql/reference/input-objects#maxfilesizeparametersinput", - "description": "Prevent commits that exceed a specified file size limit from being pushed to the\ncommit. NOTE: This rule is in beta and subject to change.
", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.
", "inputFields": [ { "name": "maxFileSize", @@ -91256,6 +91995,41 @@ } ] }, + { + "name": "RemoveSubIssueInput", + "kind": "inputObjects", + "id": "removesubissueinput", + "href": "/graphql/reference/input-objects#removesubissueinput", + "description": "Autogenerated input type of RemoveSubIssue.
", + "inputFields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "issueId", + "description": "The id of the issue.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "subIssueId", + "description": "The id of the sub-issue.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "RemoveUpvoteInput", "kind": "inputObjects", @@ -91675,6 +92449,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "enterpriseOwner", + "description": "For enterprise owner bypasses, true.
", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "organizationAdmin", "description": "For organization owner bypasses, true.
", @@ -91693,6 +92475,59 @@ } ] }, + { + "name": "ReprioritizeSubIssueInput", + "kind": "inputObjects", + "id": "reprioritizesubissueinput", + "href": "/graphql/reference/input-objects#reprioritizesubissueinput", + "description": "Autogenerated input type of ReprioritizeSubIssue.
", + "inputFields": [ + { + "name": "afterId", + "description": "The id of the sub-issue to be prioritized after (either positional argument after OR before should be specified).
", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "beforeId", + "description": "The id of the sub-issue to be prioritized before (either positional argument after OR before should be specified).
", + "type": "ID", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "issueId", + "description": "The id of the parent issue.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "subIssueId", + "description": "The id of the sub-issue to reprioritize.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "RequestReviewsInput", "kind": "inputObjects", @@ -93658,6 +94493,40 @@ } ] }, + { + "name": "UpdateEnterpriseDeployKeySettingInput", + "kind": "inputObjects", + "id": "updateenterprisedeploykeysettinginput", + "href": "/graphql/reference/input-objects#updateenterprisedeploykeysettinginput", + "description": "Autogenerated input type of UpdateEnterpriseDeployKeySetting.
", + "inputFields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "enterpriseId", + "description": "The ID of the enterprise on which to set the deploy key setting.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "settingValue", + "description": "The value for the deploy key setting on the enterprise.
", + "type": "EnterpriseEnabledDisabledSettingValue!", + "id": "enterpriseenableddisabledsettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#enterpriseenableddisabledsettingvalue" + } + ] + }, { "name": "UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput", "kind": "inputObjects", @@ -94165,6 +95034,40 @@ } ] }, + { + "name": "UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSettingInput", + "kind": "inputObjects", + "id": "updateenterprisetwofactorauthenticationdisallowedmethodssettinginput", + "href": "/graphql/reference/input-objects#updateenterprisetwofactorauthenticationdisallowedmethodssettinginput", + "description": "Autogenerated input type of UpdateEnterpriseTwoFactorAuthenticationDisallowedMethodsSetting.
", + "inputFields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.
", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "enterpriseId", + "description": "The ID of the enterprise on which to set the two-factor authentication disallowed methods setting.
", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "settingValue", + "description": "The value for the two-factor authentication disallowed methods setting on the enterprise.
", + "type": "EnterpriseDisallowedMethodsSettingValue!", + "id": "enterprisedisallowedmethodssettingvalue", + "kind": "enums", + "href": "/graphql/reference/enums#enterprisedisallowedmethodssettingvalue" + } + ] + }, { "name": "UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput", "kind": "inputObjects", diff --git a/src/graphql/data/ghes-3.16/upcoming-changes.json b/src/graphql/data/ghes-3.16/upcoming-changes.json index cf462ccc12cf..cfd1d04af8ca 100644 --- a/src/graphql/data/ghes-3.16/upcoming-changes.json +++ b/src/graphql/data/ghes-3.16/upcoming-changes.json @@ -1,4 +1,80 @@ { + "2025-10-01": [ + { + "location": "SecurityAdvisory.cvss", + "description": "cvss will be removed. New cvss_severities field will now contain both cvss_v3 and cvss_v4 properties.
cvss will be removed.
databaseId will be removed. Use fullDatabaseId instead.
databaseId will be removed because it does not support 64-bit signed integer identifiers.
databaseId will be removed. Use fullDatabaseId instead.
databaseId will be removed because it does not support 64-bit signed integer identifiers.
databaseId will be removed. Use fullDatabaseId instead.
databaseId will be removed because it does not support 64-bit signed integer identifiers.
databaseId will be removed. Use fullDatabaseId instead.
databaseId will be removed because it does not support 64-bit signed integer identifiers.
databaseId will be removed. Use fullDatabaseId instead.
databaseId will be removed because it does not support 64-bit signed integer identifiers.
hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.
has_two_factor_enabled will be removed.
hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.
has_two_factor_enabled will be removed.
hasTwoFactorEnabled will be removed. Use two_factor_method_security instead.
has_two_factor_enabled will be removed.
Commits an autofix for a code scanning alert.
\nIf an autofix is commited as a result of this request, then this endpoint will return a 201 Created response.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Commits an autofix for a code scanning alert.
\nIf an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -172263,6 +172339,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -172638,6 +172723,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -173062,6 +173156,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -173350,6 +173453,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_delegated_alert_dismissal", + "in": "body", + "description": "The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -173626,6 +173740,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -174168,6 +174291,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -175062,6 +175194,7 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -175281,6 +175414,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -384929,7 +385071,7 @@ } ], "previews": [], - "descriptionHTML": "Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub plan, GitHub Apps need the Organization plan permission.
Commits an autofix for a code scanning alert.
\nIf an autofix is commited as a result of this request, then this endpoint will return a 201 Created response.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Commits an autofix for a code scanning alert.
\nIf an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -183382,6 +183458,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -183757,6 +183842,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -184181,6 +184275,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -184469,6 +184572,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_delegated_alert_dismissal", + "in": "body", + "description": "The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -184745,6 +184859,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -185287,6 +185410,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -186181,6 +186313,7 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", "private_vulnerability_reporting": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", @@ -186400,6 +186533,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "private_vulnerability_reporting": { "type": "string", "description": "The enablement status of private vulnerability reporting", @@ -280211,9 +280353,9 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", - "title": "Get a custom property for an enterprise", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote", + "title": "Promote a custom property to an enterprise", "category": "enterprise-admin", "subcategory": "custom-properties", "parameters": [ @@ -280227,186 +280369,8 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Custom properties\" business permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "enterprise": "ENTERPRISE", - "custom_property_name": "CUSTOM_PROPERTY_NAME" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - }, - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.
", - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", - "title": "Create or update a custom property for an enterprise", - "category": "enterprise-admin", - "subcategory": "custom-properties", - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "name": "org", + "description": "The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -280423,45 +280387,7 @@ } } ], - "bodyParameters": [ - { - "type": "string", - "name": "value_type", - "in": "body", - "description": "The type of the value for the property
", - "isRequired": true, - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ] - }, - { - "type": "boolean", - "name": "required", - "in": "body", - "description": "Whether the property is required.
" - }, - { - "type": "null or string or array", - "name": "default_value", - "in": "body", - "description": "Default value of the property
" - }, - { - "type": "string or null", - "name": "description", - "in": "body", - "description": "Short description of the property
" - }, - { - "type": "array of strings or null", - "name": "allowed_values", - "in": "body", - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" - } - ], + "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, @@ -280476,19 +280402,432 @@ { "key": "default", "request": { - "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] - }, + "parameters": { + "enterprise": "ENTERPRISE", + "org": "ORG", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nPromotes an existing organization custom property to an enterprise.
\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "title": "Get a custom property for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "enterprise": "ENTERPRISE", + "custom_property_name": "CUSTOM_PROPERTY_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.
", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/properties/schema/{custom_property_name}", + "title": "Create or update a custom property for an enterprise", + "category": "enterprise-admin", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "custom_property_name", + "description": "The custom property name
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "value_type", + "in": "body", + "description": "The type of the value for the property
", + "isRequired": true, + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ] + }, + { + "type": "boolean", + "name": "required", + "in": "body", + "description": "Whether the property is required.
" + }, + { + "type": "null or string or array", + "name": "default_value", + "in": "body", + "description": "Default value of the property
" + }, + { + "type": "string or null", + "name": "description", + "in": "body", + "description": "Short description of the property
" + }, + { + "type": "array of strings or null", + "name": "allowed_values", + "in": "body", + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values.
" + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Custom properties\" business permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, "parameters": { "enterprise": "ENTERPRISE", "custom_property_name": "CUSTOM_PROPERTY_NAME" @@ -417500,7 +417839,7 @@ } ], "previews": [], - "descriptionHTML": "Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Cloud plan, GitHub Apps need the Organization plan permission.
The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repository_name", + "description": "The name of the repository to filter on.
", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "reviewer", + "description": "Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor 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).
The status of the bypass request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "used_in_tests", + "path": "/tests/README.md:16:0", + "branch": "refs/heads/main" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "fix_later", + "path": "README.md:17:0", + "branch": "refs/heads/my-branch" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Token is already revoked, I'll remove it later", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning bypass request", + "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "bypass_reason": { + "type": "string", + "enum": [ + "used_in_tests", + "false_positive", + "fix_later" + ], + "description": "The reason the bypass was requested." + }, + "path": { + "type": "string", + "description": "The path in the repo where the secret was located during the request." + }, + "branch": { + "type": "string", + "description": "The branch in the repo where the secret was located during the request." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the bypass request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the bypass request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/exemptions/1" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "List requests to bypass secret scanning push protection in an org.
\nDelegated bypass must be enabled on repositories in the org and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning", + "title": "List bypass requests for secret scanning for a repository", + "category": "secret-scanning", + "subcategory": "delegated-bypass", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
Filter bypass requests by the handle of the GitHub user who reviewed the bypass request.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "requester", + "description": "Filter bypass requests by the handle of the GitHub user who requested the bypass.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "time_period", + "description": "The time period to filter by.
\nFor 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).
The status of the bypass request to filter on. When specified, only requests with this status will be returned.
", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "cancelled", + "expired", + "denied", + "open", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A list of the bypass requests.
", + "example": [ + { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "used_in_tests", + "path": "/tests/README.md:16:0", + "branch": "refs/heads/main" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + { + "id": 12, + "number": 24, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "fix_later", + "path": "README.md:17:0", + "branch": "refs/heads/my-branch" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46255555", + "status": "denied", + "requester_comment": "Token is already revoked, I'll remove it later", + "expires_at": "2024-07-08T07:43:03Z", + "created_at": "2024-07-01T07:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/2", + "html_url": "https://github.com/octo-org/smile/exemptions/2" + } + ], + "schema": { + "type": "array", + "items": { + "title": "Secret scanning bypass request", + "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "bypass_reason": { + "type": "string", + "enum": [ + "used_in_tests", + "false_positive", + "fix_later" + ], + "description": "The reason the bypass was requested." + }, + "path": { + "type": "string", + "description": "The path in the repo where the secret was located during the request." + }, + "branch": { + "type": "string", + "description": "The branch in the repo where the secret was located during the request." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the bypass request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the bypass request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/exemptions/1" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists requests to bypass secret scanning push protection in a repository.
\nDelegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
A list of the bypass requests.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}", + "title": "Get a bypass request for secret scanning", + "category": "secret-scanning", + "subcategory": "delegated-bypass", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies the bypass request in a repository.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "bypass_request_number": "BYPASS_REQUEST_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "A single bypass request.
", + "example": { + "id": 21, + "number": 42, + "repository": { + "id": 1, + "name": "smile", + "full_name": "octo-org/smile" + }, + "organization": { + "id": 1, + "name": "octo-org" + }, + "requester": { + "actor_id": 12, + "actor_name": "monalisa" + }, + "request_type": "secret_scanning", + "data": [ + { + "secret_type": "adafruit_io_key", + "bypass_reason": "used_in_tests", + "path": "/tests/README.md:16:0", + "branch": "refs/heads/main" + } + ], + "resource_identifier": "827efc6d56897b048c772eb4087f854f46256132", + "status": "denied", + "requester_comment": "Test token used in the readme as an example", + "expires_at": "2024-07-08T08:43:03Z", + "created_at": "2024-07-01T08:43:03Z", + "responses": [ + { + "id": 42, + "reviewer": { + "actor_id": 4, + "actor_name": "octocat" + }, + "status": "denied", + "created_at": "2024-07-02T08:43:04Z" + } + ], + "url": "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1", + "html_url": "https://github.com/octo-org/smile/exemptions/1" + }, + "schema": { + "title": "Secret scanning bypass request", + "description": "A bypass request made by a user asking to be exempted from push protection in this repository.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the bypass request." + }, + "number": { + "type": "integer", + "description": "The number uniquely identifying the bypass request within its repository." + }, + "repository": { + "type": "object", + "description": "The repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the repository the bypass request is for." + }, + "name": { + "type": "string", + "description": "The name of the repository the bypass request is for." + }, + "full_name": { + "type": "string", + "description": "The full name of the repository the bypass request is for." + } + } + }, + "organization": { + "type": "object", + "description": "The organization associated with the repository the bypass request is for.", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the organization." + }, + "name": { + "type": "string", + "description": "The name of the organization." + } + } + }, + "requester": { + "type": "object", + "description": "The user who requested the bypass.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who requested the bypass." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who requested the bypass." + } + } + }, + "request_type": { + "type": "string", + "description": "The type of request." + }, + "data": { + "type": [ + "array", + "null" + ], + "description": "Data describing the push rules that are being requested to be bypassed.", + "items": { + "type": "object", + "properties": { + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "bypass_reason": { + "type": "string", + "enum": [ + "used_in_tests", + "false_positive", + "fix_later" + ], + "description": "The reason the bypass was requested." + }, + "path": { + "type": "string", + "description": "The path in the repo where the secret was located during the request." + }, + "branch": { + "type": "string", + "description": "The branch in the repo where the secret was located during the request." + } + } + } + }, + "resource_identifier": { + "type": "string", + "description": "The unique identifier for the request type of the bypass request. For example, a commit SHA.", + "examples": [ + "827efc6d56897b048c772eb4087f854f46256132" + ] + }, + "status": { + "type": "string", + "description": "The status of the bypass request.", + "enum": [ + "pending", + "denied", + "approved", + "cancelled", + "completed", + "expired", + "open" + ] + }, + "requester_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the requester provided when creating the bypass request." + }, + "expires_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request will expire." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the bypass request was created." + }, + "responses": { + "type": [ + "array", + "null" + ], + "description": "The responses to the bypass request.", + "items": { + "title": "Bypass response", + "description": "A response made by a delegated bypasser to a bypass request.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the response to the bypass request." + }, + "reviewer": { + "type": "object", + "description": "The user who reviewed the bypass request.", + "properties": { + "actor_id": { + "type": "integer", + "description": "The ID of the GitHub user who reviewed the bypass request." + }, + "actor_name": { + "type": "string", + "description": "The name of the GitHub user who reviewed the bypass request." + } + } + }, + "status": { + "type": "string", + "description": "The response status to the bypass request until dismissed.", + "enum": [ + "approved", + "denied", + "dismissed" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The date and time the response to the bypass request was created." + } + } + } + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octo-org/smile/bypass-requests/secret-scanning/1" + ] + }, + "html_url": { + "type": "string", + "description": "The URL to view the bypass request in a browser.", + "format": "uri", + "examples": [ + "https://github.com/octo-org/smile/exemptions/1" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a specific request to bypass secret scanning push protection in a repository.
\nDelegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
A single bypass request.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/bypass-requests/secret-scanning/{bypass_request_number}", + "title": "Review a bypass request for secret scanning", + "category": "secret-scanning", + "subcategory": "delegated-bypass", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The number that identifies the bypass request in a repository.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "status", + "in": "body", + "description": "The review action to perform on the bypass request.
", + "isRequired": true, + "enum": [ + "approve", + "reject" + ] + }, + { + "type": "string", + "name": "message", + "in": "body", + "description": "A message to include with the review. Has a maximum character length of 2048.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "status": "reject", + "message": "This secret has not been revoked." + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "bypass_request_number": "BYPASS_REQUEST_NUMBER" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The review of the bypass request.
", + "example": { + "bypass_review_id": 1 + }, + "schema": { + "type": "object", + "properties": { + "bypass_review_id": { + "type": "integer", + "description": "ID of the bypass review." + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Approve or deny a request to bypass secret scanning push protection in a repository.
\nDelegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
The review of the bypass request.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/bypass-responses/secret-scanning/{bypass_response_id}", + "title": "Dismiss a response on a bypass request for secret scanning", + "category": "secret-scanning", + "subcategory": "delegated-bypass", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
ID of the bypass response.
", + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": false, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secret scanning alerts\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "bypass_response_id": "BYPASS_RESPONSE_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Review was successfully dismissed.
" + } + } + ], + "previews": [], + "descriptionHTML": "Dissmiss a response given to a bypass request for secret scanning push protection in a repository.
\nDelegated bypass must be enabled on the repository and the user must be a bypass reviewer to access this endpoint.\nPersonal access tokens (classic) need the security_events scope to use this endpoint.
Review was successfully dismissed.
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + } ] }, "security-advisories": { diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index cf7aa51a71e6..3c85c2a8503f 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -333976,7 +333976,7 @@ } ], "previews": [], - "descriptionHTML": "Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -160918,6 +160938,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -161217,6 +161246,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -161575,6 +161613,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -161807,6 +161854,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_delegated_alert_dismissal", + "in": "body", + "description": "The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -162026,6 +162084,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -162502,6 +162569,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -163383,6 +163459,7 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -163553,6 +163630,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -337577,7 +337663,7 @@ } ], "previews": [], - "descriptionHTML": "Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -164388,6 +164462,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -164716,6 +164799,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -165107,6 +165199,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -165362,6 +165463,17 @@ "not_set" ] }, + { + "type": "string", + "name": "secret_scanning_delegated_alert_dismissal", + "in": "body", + "description": "The enablement status of secret scanning delegated alert dismissal
", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, { "type": "string", "name": "private_vulnerability_reporting", @@ -165614,6 +165726,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -166123,6 +166244,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -167004,6 +167134,7 @@ "secret_scanning_delegated_bypass": "disabled", "secret_scanning_validity_checks": "disabled", "secret_scanning_non_provider_patterns": "disabled", + "secret_scanning_delegated_alert_dismissal": "disabled", "enforcement": "enforced", "url": "https://api.github.com/orgs/octo-org/code-security/configurations/1325", "html_url": "https://github.com/organizations/octo-org/settings/security_products/configurations/edit/1325", @@ -167203,6 +167334,15 @@ "not_set" ] }, + "secret_scanning_delegated_alert_dismissal": { + "type": "string", + "description": "The enablement status of secret scanning delegated alert dismissal", + "enum": [ + "enabled", + "disabled", + "not_set" + ] + }, "enforcement": { "type": "string", "description": "The enforcement status for a security configuration", @@ -215195,10 +215335,8 @@ "signup_enabled": false, "github_hostname": "ghe.local", "identicons_host": "dotcom", - "http_proxy": null, "auth_mode": "default", "expire_sessions": false, - "admin_password": null, "configuration_id": 1401777404, "configuration_run_count": 4, "avatar": { @@ -215293,7 +215431,6 @@ "primary_server": "0.pool.ntp.org", "secondary_server": "1.pool.ntp.org" }, - "timezone": null, "snmp": { "enabled": false, "community": "" @@ -215303,7 +215440,6 @@ "server": null, "protocol_name": "udp" }, - "assets": null, "pages": { "enabled": true }, @@ -215321,7 +215457,10 @@ "basemap": "company.map-qsz2zrvs", "token": null }, - "load_balancer": null + "prometheus": { + "enabled": false, + "trusted_ips": "10.0.0.1, 192.168.1.0/8" + } }, "schema": { "type": "object", @@ -215800,6 +215939,20 @@ "string", "null" ] + }, + "prometheus": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "trusted_ips": { + "type": [ + "string", + "null" + ] + } + } } } } @@ -342867,7 +343020,7 @@ } ], "previews": [], - "descriptionHTML": "Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.
Gets information about an organization.
\nWhen the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, outside collaborators, guest collaborators, repository collaborators, or everyone with access to any repository within the organization to enable two-factor authentication.
To see the full details about an organization, the authenticated user must be an organization owner.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to see the full details about an organization.
To see information about an organization's GitHub Enterprise Server plan, GitHub Apps need the Organization plan permission.