Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Updates docs, adds public-user[notification_email], api-overview[actions_macos], full-repository-default-response[allow_forking], page[pending_domain_unverified_at, protected_domain_state], (GHES 3.11-3.12) removes [repository-rule-params-restricted-commits, repository-rule-params-code-scanning-tool] #99

Merged
merged 9 commits into from
Jul 9, 2024
Merged

feat: Updates docs, adds public-user[notification_email], api-overview[actions_macos], full-repository-default-response[allow_forking], page[pending_domain_unverified_at, protected_domain_state], (GHES 3.11-3.12) removes [repository-rule-params-restricted-commits, repository-rule-params-code-scanning-tool] #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dae1487
WIP: schema updates
Apr 26, 2024
43f6ad0
WIP: schema updates
Apr 27, 2024
5d664cc
WIP: schema updates
Apr 30, 2024
05fff64
WIP: schema updates
May 1, 2024
51a6680
WIP: schema updates
May 2, 2024
04514de
WIP: schema updates
May 3, 2024
56013f4
WIP: schema updates
May 9, 2024
f153bc6
WIP: schema updates
May 10, 2024
92bf4e2
WIP: schema updates
May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
661 changes: 650 additions & 11 deletions cache/api.github.com.json
View file
Open in desktop

Large diffs are not rendered by default.

662 changes: 651 additions & 11 deletions cache/ghec.json
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 21 additions & 3 deletions cache/ghes-3.10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14416,7 +14416,7 @@
},
"push": {
"post": {
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.",
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.",
"operationId": "push",
"externalDocs": {
"url": "https://docs.github.com/enterprise-server@3.10/webhooks/webhook-events-and-payloads#push"
Expand Down Expand Up @@ -24308,6 +24308,10 @@
"blog": { "type": ["string", "null"] },
"location": { "type": ["string", "null"] },
"email": { "type": ["string", "null"], "format": "email" },
"notification_email": {
"type": ["string", "null"],
"format": "email"
},
"hireable": { "type": ["boolean", "null"] },
"bio": { "type": ["string", "null"] },
"twitter_username": { "type": ["string", "null"] },
Expand Down Expand Up @@ -24893,6 +24897,11 @@
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"actions_macos": {
"type": "array",
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"dependabot": {
"type": "array",
"items": { "type": "string" },
Expand Down Expand Up @@ -38874,6 +38883,11 @@
"format": "email",
"examples": ["octocat@github.com"]
},
"notification_email": {
"type": ["string", "null"],
"format": "email",
"examples": ["octocat@github.com"]
},
"hireable": { "type": ["boolean", "null"] },
"bio": {
"type": ["string", "null"],
Expand Down Expand Up @@ -121527,6 +121541,7 @@
"value": {
"verifiable_password_authentication": true,
"packages": ["192.0.2.1"],
"actions_macos": ["192.0.2.1"],
"dependabot": ["192.0.2.1"],
"domains": {
"website": ["*.example.com"],
Expand Down Expand Up @@ -125433,6 +125448,7 @@
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"allow_forking": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
Expand Down Expand Up @@ -130911,8 +130927,8 @@
"versionInfo": "1.0.0",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"licenseConcluded": "MIT",
"licenseDeclared": "MIT"
"licenseConcluded": "NOASSERTION",
"licenseDeclared": "NOASSERTION"
}
]
}
Expand Down Expand Up @@ -133222,6 +133238,8 @@
"html_url": "https://developer.github.com",
"source": { "branch": "master", "path": "/" },
"public": true,
"pending_domain_unverified_at": "2024-04-30T19:33:31Z",
"protected_domain_state": "verified",
"https_certificate": {
"state": "approved",
"description": "Certificate is approved",
Expand Down
70 changes: 22 additions & 48 deletions cache/ghes-3.11.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14566,7 +14566,7 @@
},
"push": {
"post": {
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.",
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.",
"operationId": "push",
"externalDocs": {
"url": "https://docs.github.com/enterprise-server@3.11/webhooks/webhook-events-and-payloads#push"
Expand Down Expand Up @@ -24952,6 +24952,10 @@
"blog": { "type": ["string", "null"] },
"location": { "type": ["string", "null"] },
"email": { "type": ["string", "null"], "format": "email" },
"notification_email": {
"type": ["string", "null"],
"format": "email"
},
"hireable": { "type": ["boolean", "null"] },
"bio": { "type": ["string", "null"] },
"twitter_username": { "type": ["string", "null"] },
Expand Down Expand Up @@ -25537,6 +25541,11 @@
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"actions_macos": {
"type": "array",
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"dependabot": {
"type": "array",
"items": { "type": "string" },
Expand Down Expand Up @@ -27984,7 +27993,7 @@
},
"bypass_mode": {
"type": "string",
"description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.",
"description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n",
"enum": ["always", "pull_request"]
}
}
Expand Down Expand Up @@ -28413,22 +28422,6 @@
}
}
},
"repository-rule-params-restricted-commits": {
"title": "RestrictedCommits",
"description": "Restricted commit",
"type": "object",
"properties": {
"oid": {
"type": "string",
"description": "Full or abbreviated commit hash to reject"
},
"reason": {
"type": "string",
"description": "Reason for restriction"
}
},
"required": ["oid"]
},
"repository-rule-params-workflow-file-reference": {
"title": "WorkflowFileReference",
"description": "A workflow that must run for this rule to pass",
Expand Down Expand Up @@ -28475,34 +28468,6 @@
}
}
},
"repository-rule-params-code-scanning-tool": {
"title": "CodeScanningTool",
"description": "A tool that must provide code scanning results for this rule to pass.",
"type": "object",
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": ["none", "errors", "errors_and_warnings", "all"]
},
"security_alerts_threshold": {
"type": "string",
"description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"critical",
"high_or_higher",
"medium_or_higher",
"all"
]
},
"tool": {
"type": "string",
"description": "The name of a code scanning tool"
}
},
"required": ["alerts_threshold", "security_alerts_threshold", "tool"]
},
"repository-rule": {
"title": "Repository Rule",
"type": "object",
Expand Down Expand Up @@ -40395,6 +40360,11 @@
"format": "email",
"examples": ["octocat@github.com"]
},
"notification_email": {
"type": ["string", "null"],
"format": "email",
"examples": ["octocat@github.com"]
},
"hireable": { "type": ["boolean", "null"] },
"bio": {
"type": ["string", "null"],
Expand Down Expand Up @@ -123390,6 +123360,7 @@
"value": {
"verifiable_password_authentication": true,
"packages": ["192.0.2.1"],
"actions_macos": ["192.0.2.1"],
"dependabot": ["192.0.2.1"],
"domains": {
"website": ["*.example.com"],
Expand Down Expand Up @@ -127380,6 +127351,7 @@
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"allow_forking": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
Expand Down Expand Up @@ -132892,8 +132864,8 @@
"versionInfo": "1.0.0",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"licenseConcluded": "MIT",
"licenseDeclared": "MIT"
"licenseConcluded": "NOASSERTION",
"licenseDeclared": "NOASSERTION"
}
]
}
Expand Down Expand Up @@ -135205,6 +135177,8 @@
"html_url": "https://developer.github.com",
"source": { "branch": "master", "path": "/" },
"public": true,
"pending_domain_unverified_at": "2024-04-30T19:33:31Z",
"protected_domain_state": "verified",
"https_certificate": {
"state": "approved",
"description": "Certificate is approved",
Expand Down
70 changes: 22 additions & 48 deletions cache/ghes-3.12.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14740,7 +14740,7 @@
},
"push": {
"post": {
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: An event will not be created when more than three tags are pushed at once.",
"summary": "This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Note**: Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.",
"operationId": "push",
"externalDocs": {
"url": "https://docs.github.com/enterprise-server@3.12/webhooks/webhook-events-and-payloads#push"
Expand Down Expand Up @@ -25155,6 +25155,10 @@
"blog": { "type": ["string", "null"] },
"location": { "type": ["string", "null"] },
"email": { "type": ["string", "null"], "format": "email" },
"notification_email": {
"type": ["string", "null"],
"format": "email"
},
"hireable": { "type": ["boolean", "null"] },
"bio": { "type": ["string", "null"] },
"twitter_username": { "type": ["string", "null"] },
Expand Down Expand Up @@ -26182,6 +26186,11 @@
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"actions_macos": {
"type": "array",
"items": { "type": "string" },
"examples": ["192.0.2.1"]
},
"dependabot": {
"type": "array",
"items": { "type": "string" },
Expand Down Expand Up @@ -28634,7 +28643,7 @@
},
"bypass_mode": {
"type": "string",
"description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests.",
"description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type.\n",
"enum": ["always", "pull_request"]
}
}
Expand Down Expand Up @@ -29063,22 +29072,6 @@
}
}
},
"repository-rule-params-restricted-commits": {
"title": "RestrictedCommits",
"description": "Restricted commit",
"type": "object",
"properties": {
"oid": {
"type": "string",
"description": "Full or abbreviated commit hash to reject"
},
"reason": {
"type": "string",
"description": "Reason for restriction"
}
},
"required": ["oid"]
},
"repository-rule-params-workflow-file-reference": {
"title": "WorkflowFileReference",
"description": "A workflow that must run for this rule to pass",
Expand Down Expand Up @@ -29125,34 +29118,6 @@
}
}
},
"repository-rule-params-code-scanning-tool": {
"title": "CodeScanningTool",
"description": "A tool that must provide code scanning results for this rule to pass.",
"type": "object",
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": ["none", "errors", "errors_and_warnings", "all"]
},
"security_alerts_threshold": {
"type": "string",
"description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"critical",
"high_or_higher",
"medium_or_higher",
"all"
]
},
"tool": {
"type": "string",
"description": "The name of a code scanning tool"
}
},
"required": ["alerts_threshold", "security_alerts_threshold", "tool"]
},
"repository-rule": {
"title": "Repository Rule",
"type": "object",
Expand Down Expand Up @@ -41216,6 +41181,11 @@
"format": "email",
"examples": ["octocat@github.com"]
},
"notification_email": {
"type": ["string", "null"],
"format": "email",
"examples": ["octocat@github.com"]
},
"hireable": { "type": ["boolean", "null"] },
"bio": {
"type": ["string", "null"],
Expand Down Expand Up @@ -124465,6 +124435,7 @@
"value": {
"verifiable_password_authentication": true,
"packages": ["192.0.2.1"],
"actions_macos": ["192.0.2.1"],
"dependabot": ["192.0.2.1"],
"domains": {
"website": ["*.example.com"],
Expand Down Expand Up @@ -128528,6 +128499,7 @@
"allow_auto_merge": false,
"delete_branch_on_merge": true,
"allow_merge_commit": true,
"allow_forking": true,
"subscribers_count": 42,
"network_count": 0,
"license": {
Expand Down Expand Up @@ -134040,8 +134012,8 @@
"versionInfo": "1.0.0",
"downloadLocation": "NOASSERTION",
"filesAnalyzed": false,
"licenseConcluded": "MIT",
"licenseDeclared": "MIT"
"licenseConcluded": "NOASSERTION",
"licenseDeclared": "NOASSERTION"
}
]
}
Expand Down Expand Up @@ -136361,6 +136333,8 @@
"html_url": "https://developer.github.com",
"source": { "branch": "master", "path": "/" },
"public": true,
"pending_domain_unverified_at": "2024-04-30T19:33:31Z",
"protected_domain_state": "verified",
"https_certificate": {
"state": "approved",
"description": "Certificate is approved",
Expand Down
Loading