Skip to content

Commit 66c53a4

Browse files
octokitbotoctokitbot
authored
chore: update auto-generated docs (#533)
WIP octokit/openapi updated
1 parent 93fd5f5 commit 66c53a4

8 files changed

Lines changed: 438 additions & 10 deletions

File tree

‎docs/apps/createInstallationAccessToken.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ The level of permission to grant the access token for checks on code.
6868

6969
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
7070

71+
</td></tr>
72+
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
73+
74+
The level of permission to grant the access token for custom roles management.
75+
7176
</td></tr>
7277
<tr><td>permissions.deployments</td><td>no</td><td>
7378

‎docs/apps/scopeToken.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,11 @@ The level of permission to grant the access token for checks on code.
8282

8383
The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
8484

85+
</td></tr>
86+
<tr><td>permissions.organization_custom_roles</td><td>no</td><td>
87+
88+
The level of permission to grant the access token for custom roles management.
89+
8590
</td></tr>
8691
<tr><td>permissions.deployments</td><td>no</td><td>
8792

‎docs/dependencyGraph/createRepositorySnapshot.md‎

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,13 +113,11 @@ User-defined metadata to store domain-specific information limited to 8 keys wit
113113
</td></tr>
114114
<tr><td>manifests</td><td>no</td><td>
115115

116-
A collection of package manifests
116+
A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
117117

118118
</td></tr>
119119
<tr><td>manifests.*</td><td>no</td><td>
120120

121-
A collection of related dependencies declared in a file or representing a logical group of dependencies.
122-
123121
</td></tr>
124122
<tr><td>manifests.*.name</td><td>yes</td><td>
125123

@@ -144,6 +142,39 @@ User-defined metadata to store domain-specific information limited to 8 keys wit
144142
</td></tr>
145143
<tr><td>manifests.*.resolved</td><td>no</td><td>
146144

145+
A collection of resolved package dependencies.
146+
147+
</td></tr>
148+
<tr><td>manifests.*.resolved.*</td><td>no</td><td>
149+
150+
</td></tr>
151+
<tr><td>manifests.*.resolved.*.package_url</td><td>no</td><td>
152+
153+
Package-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details.
154+
155+
</td></tr>
156+
<tr><td>manifests.*.resolved.*.metadata</td><td>no</td><td>
157+
158+
User-defined metadata to store domain-specific information limited to 8 keys with scalar values.
159+
160+
</td></tr>
161+
<tr><td>manifests.*.resolved.*.metadata.*</td><td>no</td><td>
162+
163+
</td></tr>
164+
<tr><td>manifests.*.resolved.*.relationship</td><td>no</td><td>
165+
166+
A notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency.
167+
168+
</td></tr>
169+
<tr><td>manifests.*.resolved.*.scope</td><td>no</td><td>
170+
171+
A notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes.
172+
173+
</td></tr>
174+
<tr><td>manifests.*.resolved.*.dependencies</td><td>no</td><td>
175+
176+
Array of package-url (PURLs) of direct child dependencies.
177+
147178
</td></tr>
148179
<tr><td>scanned</td><td>yes</td><td>
149180

‎docs/orgs/listCustomRoles.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ octokit.rest.orgs.listCustomRoles({
3232
<tbody>
3333
<tr><td>organization_id</td><td>yes</td><td>
3434

35+
The unique identifier of the organization.
36+
3537
</td></tr>
3638
</tbody>
3739
</table>

‎docs/repos/createForAuthenticatedUser.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,40 @@ Whether to allow Auto-merge to be used on pull requests.
113113

114114
Whether to delete head branches when pull requests are merged
115115

116+
</td></tr>
117+
<tr><td>squash_merge_commit_title</td><td>no</td><td>
118+
119+
The default value for a squash merge commit title:
120+
121+
- `PR_TITLE` - default to the pull request's title.
122+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
123+
124+
</td></tr>
125+
<tr><td>squash_merge_commit_message</td><td>no</td><td>
126+
127+
The default value for a squash merge commit message:
128+
129+
- `PR_BODY` - default to the pull request's body.
130+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
131+
- `BLANK` - default to a blank commit message.
132+
133+
</td></tr>
134+
<tr><td>merge_commit_title</td><td>no</td><td>
135+
136+
The default value for a merge commit title.
137+
138+
- `PR_TITLE` - default to the pull request's title.
139+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
140+
141+
</td></tr>
142+
<tr><td>merge_commit_message</td><td>no</td><td>
143+
144+
The default value for a merge commit message.
145+
146+
- `PR_TITLE` - default to the pull request's title.
147+
- `PR_BODY` - default to the pull request's body.
148+
- `BLANK` - default to a blank commit message.
149+
116150
</td></tr>
117151
<tr><td>has_downloads</td><td>no</td><td>
118152

‎docs/repos/createInOrg.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,40 @@ Either `true` to allow automatically deleting head branches when pull requests a
134134

135135
Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.
136136

137+
</td></tr>
138+
<tr><td>squash_merge_commit_title</td><td>no</td><td>
139+
140+
The default value for a squash merge commit title:
141+
142+
- `PR_TITLE` - default to the pull request's title.
143+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
144+
145+
</td></tr>
146+
<tr><td>squash_merge_commit_message</td><td>no</td><td>
147+
148+
The default value for a squash merge commit message:
149+
150+
- `PR_BODY` - default to the pull request's body.
151+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
152+
- `BLANK` - default to a blank commit message.
153+
154+
</td></tr>
155+
<tr><td>merge_commit_title</td><td>no</td><td>
156+
157+
The default value for a merge commit title.
158+
159+
- `PR_TITLE` - default to the pull request's title.
160+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
161+
162+
</td></tr>
163+
<tr><td>merge_commit_message</td><td>no</td><td>
164+
165+
The default value for a merge commit message.
166+
167+
- `PR_TITLE` - default to the pull request's title.
168+
- `PR_BODY` - default to the pull request's body.
169+
- `BLANK` - default to a blank commit message.
170+
137171
</td></tr>
138172
</tbody>
139173
</table>

‎docs/repos/update.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,40 @@ Either `true` to always allow a pull request head branch that is behind its base
165165

166166
Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.
167167

168+
</td></tr>
169+
<tr><td>squash_merge_commit_title</td><td>no</td><td>
170+
171+
The default value for a squash merge commit title:
172+
173+
- `PR_TITLE` - default to the pull request's title.
174+
- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).
175+
176+
</td></tr>
177+
<tr><td>squash_merge_commit_message</td><td>no</td><td>
178+
179+
The default value for a squash merge commit message:
180+
181+
- `PR_BODY` - default to the pull request's body.
182+
- `COMMIT_MESSAGES` - default to the branch's commit messages.
183+
- `BLANK` - default to a blank commit message.
184+
185+
</td></tr>
186+
<tr><td>merge_commit_title</td><td>no</td><td>
187+
188+
The default value for a merge commit title.
189+
190+
- `PR_TITLE` - default to the pull request's title.
191+
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).
192+
193+
</td></tr>
194+
<tr><td>merge_commit_message</td><td>no</td><td>
195+
196+
The default value for a merge commit message.
197+
198+
- `PR_TITLE` - default to the pull request's title.
199+
- `PR_BODY` - default to the pull request's body.
200+
- `BLANK` - default to a blank commit message.
201+
168202
</td></tr>
169203
<tr><td>archived</td><td>no</td><td>
170204

0 commit comments

Comments
 (0)