Skip to content

Commit ed10621

Browse files
gmlewisgmlewis
authored
chore: Update openapi_operations.yaml (#4398)
1 parent 227adb5 commit ed10621

2 files changed

Lines changed: 131 additions & 13 deletions

File tree

‎github/classroom.go‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,9 @@ func (g AssignmentGrade) String() string {
107107
// returned if the current user is an administrator of the GitHub Classroom
108108
// for the assignment.
109109
//
110-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#get-an-assignment
110+
// Deprecated: This endpoint has been deprecated by GitHub.
111+
//
112+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---get-an-assignment
111113
//
112114
//meta:operation GET /assignments/{assignment_id}
113115
func (s *ClassroomService) GetAssignment(ctx context.Context, assignmentID int64) (*ClassroomAssignment, *Response, error) {
@@ -130,7 +132,9 @@ func (s *ClassroomService) GetAssignment(ctx context.Context, assignmentID int64
130132
// GetClassroom gets a GitHub Classroom for the current user. Classroom will only be
131133
// returned if the current user is an administrator of the GitHub Classroom.
132134
//
133-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#get-a-classroom
135+
// Deprecated: This endpoint has been deprecated by GitHub.
136+
//
137+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---get-a-classroom
134138
//
135139
//meta:operation GET /classrooms/{classroom_id}
136140
func (s *ClassroomService) GetClassroom(ctx context.Context, classroomID int64) (*Classroom, *Response, error) {
@@ -153,7 +157,9 @@ func (s *ClassroomService) GetClassroom(ctx context.Context, classroomID int64)
153157
// ListClassrooms lists GitHub Classrooms for the current user. Classrooms will only be
154158
// returned if the current user is an administrator of one or more GitHub Classrooms.
155159
//
156-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#list-classrooms
160+
// Deprecated: This endpoint has been deprecated by GitHub.
161+
//
162+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---list-classrooms
157163
//
158164
//meta:operation GET /classrooms
159165
func (s *ClassroomService) ListClassrooms(ctx context.Context, opts *ListOptions) ([]*Classroom, *Response, error) {
@@ -179,7 +185,9 @@ func (s *ClassroomService) ListClassrooms(ctx context.Context, opts *ListOptions
179185
// ListClassroomAssignments lists GitHub Classroom assignments for a classroom. Assignments will only be
180186
// returned if the current user is an administrator of the GitHub Classroom.
181187
//
182-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#list-assignments-for-a-classroom
188+
// Deprecated: This endpoint has been deprecated by GitHub.
189+
//
190+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---list-assignments-for-a-classroom
183191
//
184192
//meta:operation GET /classrooms/{classroom_id}/assignments
185193
func (s *ClassroomService) ListClassroomAssignments(ctx context.Context, classroomID int64, opts *ListOptions) ([]*ClassroomAssignment, *Response, error) {
@@ -207,7 +215,9 @@ func (s *ClassroomService) ListClassroomAssignments(ctx context.Context, classro
207215
// Accepted assignments will only be returned if the current user is an administrator
208216
// of the GitHub Classroom for the assignment.
209217
//
210-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#list-accepted-assignments-for-an-assignment
218+
// Deprecated: This endpoint has been deprecated by GitHub.
219+
//
220+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---list-accepted-assignments-for-an-assignment
211221
//
212222
//meta:operation GET /assignments/{assignment_id}/accepted_assignments
213223
func (s *ClassroomService) ListAcceptedAssignments(ctx context.Context, assignmentID int64, opts *ListOptions) ([]*AcceptedAssignment, *Response, error) {
@@ -235,7 +245,9 @@ func (s *ClassroomService) ListAcceptedAssignments(ctx context.Context, assignme
235245
// Grades will only be returned if the current user is an administrator
236246
// of the GitHub Classroom for the assignment.
237247
//
238-
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#get-assignment-grades
248+
// Deprecated: This endpoint has been deprecated by GitHub.
249+
//
250+
// GitHub API docs: https://docs.github.com/rest/classroom/classroom?apiVersion=2022-11-28#closing-down---get-assignment-grades
239251
//
240252
//meta:operation GET /assignments/{assignment_id}/grades
241253
func (s *ClassroomService) GetAssignmentGrades(ctx context.Context, assignmentID int64) ([]*AssignmentGrade, *Response, error) {

‎openapi_operations.yaml‎

Lines changed: 113 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ operation_overrides:
105105
documentation_url: https://docs.github.com/rest/pages/pages#request-a-github-pages-build
106106
- name: GET /repos/{owner}/{repo}/pages/builds/{build_id}
107107
documentation_url: https://docs.github.com/rest/pages/pages#get-github-pages-build
108-
openapi_commit: a70b6c5b86500ea35cb362ba0cbc940a7bb2155e
108+
openapi_commit: 03ca9c1cac754ec9b8369dc75de8a8c753c6e087
109109
openapi_operations:
110110
- name: GET /
111111
documentation_url: https://docs.github.com/rest/meta/meta#github-api-root
@@ -438,20 +438,23 @@ openapi_operations:
438438
- descriptions/ghec/ghec.json
439439
- descriptions/ghes-3.21/ghes-3.21.json
440440
- name: GET /assignments/{assignment_id}
441-
documentation_url: https://docs.github.com/rest/classroom/classroom#get-an-assignment
441+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---get-an-assignment
442442
openapi_files:
443443
- descriptions/api.github.com/api.github.com.json
444444
- descriptions/ghec/ghec.json
445+
deprecated: true
445446
- name: GET /assignments/{assignment_id}/accepted_assignments
446-
documentation_url: https://docs.github.com/rest/classroom/classroom#list-accepted-assignments-for-an-assignment
447+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---list-accepted-assignments-for-an-assignment
447448
openapi_files:
448449
- descriptions/api.github.com/api.github.com.json
449450
- descriptions/ghec/ghec.json
451+
deprecated: true
450452
- name: GET /assignments/{assignment_id}/grades
451-
documentation_url: https://docs.github.com/rest/classroom/classroom#get-assignment-grades
453+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---get-assignment-grades
452454
openapi_files:
453455
- descriptions/api.github.com/api.github.com.json
454456
- descriptions/ghec/ghec.json
457+
deprecated: true
455458
- name: GET /authorizations
456459
documentation_url: https://docs.github.com/enterprise-server@3.21/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations
457460
openapi_files:
@@ -488,20 +491,23 @@ openapi_operations:
488491
- descriptions/ghes-3.21/ghes-3.21.json
489492
deprecated: true
490493
- name: GET /classrooms
491-
documentation_url: https://docs.github.com/rest/classroom/classroom#list-classrooms
494+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---list-classrooms
492495
openapi_files:
493496
- descriptions/api.github.com/api.github.com.json
494497
- descriptions/ghec/ghec.json
498+
deprecated: true
495499
- name: GET /classrooms/{classroom_id}
496-
documentation_url: https://docs.github.com/rest/classroom/classroom#get-a-classroom
500+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---get-a-classroom
497501
openapi_files:
498502
- descriptions/api.github.com/api.github.com.json
499503
- descriptions/ghec/ghec.json
504+
deprecated: true
500505
- name: GET /classrooms/{classroom_id}/assignments
501-
documentation_url: https://docs.github.com/rest/classroom/classroom#list-assignments-for-a-classroom
506+
documentation_url: https://docs.github.com/rest/classroom/classroom#closing-down---list-assignments-for-a-classroom
502507
openapi_files:
503508
- descriptions/api.github.com/api.github.com.json
504509
- descriptions/ghec/ghec.json
510+
deprecated: true
505511
- name: GET /codes_of_conduct
506512
documentation_url: https://docs.github.com/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct
507513
openapi_files:
@@ -1163,6 +1169,11 @@ openapi_operations:
11631169
openapi_files:
11641170
- descriptions/api.github.com/api.github.com.json
11651171
- descriptions/ghec/ghec.json
1172+
- name: GET /enterprises/{enterprise}/copilot/metrics/reports/repos-1-day
1173+
documentation_url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-repository-report-for-a-specific-day
1174+
openapi_files:
1175+
- descriptions/api.github.com/api.github.com.json
1176+
- descriptions/ghec/ghec.json
11661177
- name: GET /enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day
11671178
documentation_url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day
11681179
openapi_files:
@@ -1271,6 +1282,14 @@ openapi_operations:
12711282
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/enterprise-roles#list-users-that-are-assigned-to-an-enterprise-role
12721283
openapi_files:
12731284
- descriptions/ghec/ghec.json
1285+
- name: POST /enterprises/{enterprise}/innersource-vulnerabilities/sync
1286+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/security-advisories#sync-innersource-vulnerabilities-for-an-enterprise
1287+
openapi_files:
1288+
- descriptions/ghec/ghec.json
1289+
- name: GET /enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id}
1290+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/security-advisories#get-innersource-vulnerability-sync-status-for-an-enterprise
1291+
openapi_files:
1292+
- descriptions/ghec/ghec.json
12741293
- name: GET /enterprises/{enterprise}/installation
12751294
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/apps/apps#get-an-enterprise-installation-for-the-authenticated-app
12761295
openapi_files:
@@ -1404,6 +1423,22 @@ openapi_operations:
14041423
openapi_files:
14051424
- descriptions/ghec/ghec.json
14061425
- descriptions/ghes-3.21/ghes-3.21.json
1426+
- name: DELETE /enterprises/{enterprise}/secret-scanning/custom-patterns
1427+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/custom-patterns#bulk-delete-enterprise-custom-patterns
1428+
openapi_files:
1429+
- descriptions/ghec/ghec.json
1430+
- name: GET /enterprises/{enterprise}/secret-scanning/custom-patterns
1431+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/custom-patterns#list-enterprise-custom-patterns
1432+
openapi_files:
1433+
- descriptions/ghec/ghec.json
1434+
- name: POST /enterprises/{enterprise}/secret-scanning/custom-patterns
1435+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/custom-patterns#bulk-create-enterprise-custom-patterns
1436+
openapi_files:
1437+
- descriptions/ghec/ghec.json
1438+
- name: PATCH /enterprises/{enterprise}/secret-scanning/custom-patterns/{pattern_id}
1439+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/custom-patterns#update-an-enterprise-custom-pattern
1440+
openapi_files:
1441+
- descriptions/ghec/ghec.json
14071442
- name: GET /enterprises/{enterprise}/secret-scanning/pattern-configurations
14081443
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/secret-scanning/push-protection#list-enterprise-pattern-configurations
14091444
openapi_files:
@@ -1600,6 +1635,18 @@ openapi_operations:
16001635
- descriptions/api.github.com/api.github.com.json
16011636
- descriptions/ghec/ghec.json
16021637
- descriptions/ghes-3.21/ghes-3.21.json
1638+
- name: GET /enterprises/{enterprise}/visual-studio-subscriptions
1639+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#get-a-list-of-visual-studio-subscriptions-for-the-enterprise
1640+
openapi_files:
1641+
- descriptions/ghec/ghec.json
1642+
- name: DELETE /enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}
1643+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#delete-a-visual-studio-subscription-user-match
1644+
openapi_files:
1645+
- descriptions/ghec/ghec.json
1646+
- name: PUT /enterprises/{enterprise}/visual-studio-subscriptions/{visual_studio_subscription_id}
1647+
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/licensing#add-or-update-a-visual-studio-subscription-user-match
1648+
openapi_files:
1649+
- descriptions/ghec/ghec.json
16031650
- name: POST /enterprises/{enterprise}/{security_product}/{enablement}
16041651
documentation_url: https://docs.github.com/enterprise-cloud@latest/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature
16051652
openapi_files:
@@ -3072,6 +3119,11 @@ openapi_operations:
30723119
openapi_files:
30733120
- descriptions/api.github.com/api.github.com.json
30743121
- descriptions/ghec/ghec.json
3122+
- name: GET /orgs/{org}/copilot/metrics/reports/repos-1-day
3123+
documentation_url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-repository-report-for-a-specific-day
3124+
openapi_files:
3125+
- descriptions/api.github.com/api.github.com.json
3126+
- descriptions/ghec/ghec.json
30753127
- name: GET /orgs/{org}/copilot/metrics/reports/user-teams-1-day
30763128
documentation_url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day
30773129
openapi_files:
@@ -4044,6 +4096,26 @@ openapi_operations:
40444096
- descriptions/api.github.com/api.github.com.json
40454097
- descriptions/ghec/ghec.json
40464098
- descriptions/ghes-3.21/ghes-3.21.json
4099+
- name: DELETE /orgs/{org}/secret-scanning/custom-patterns
4100+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-organization-custom-patterns
4101+
openapi_files:
4102+
- descriptions/api.github.com/api.github.com.json
4103+
- descriptions/ghec/ghec.json
4104+
- name: GET /orgs/{org}/secret-scanning/custom-patterns
4105+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-organization-custom-patterns
4106+
openapi_files:
4107+
- descriptions/api.github.com/api.github.com.json
4108+
- descriptions/ghec/ghec.json
4109+
- name: POST /orgs/{org}/secret-scanning/custom-patterns
4110+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-organization-custom-patterns
4111+
openapi_files:
4112+
- descriptions/api.github.com/api.github.com.json
4113+
- descriptions/ghec/ghec.json
4114+
- name: PATCH /orgs/{org}/secret-scanning/custom-patterns/{pattern_id}
4115+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-an-organization-custom-pattern
4116+
openapi_files:
4117+
- descriptions/api.github.com/api.github.com.json
4118+
- descriptions/ghec/ghec.json
40474119
- name: GET /orgs/{org}/secret-scanning/pattern-configurations
40484120
documentation_url: https://docs.github.com/rest/secret-scanning/push-protection#list-organization-pattern-configurations
40494121
openapi_files:
@@ -5446,18 +5518,22 @@ openapi_operations:
54465518
documentation_url: https://docs.github.com/rest/code-quality/code-quality#list-code-quality-findings-for-a-repository
54475519
openapi_files:
54485520
- descriptions/api.github.com/api.github.com.json
5521+
- descriptions/ghec/ghec.json
54495522
- name: GET /repos/{owner}/{repo}/code-quality/findings/{finding_number}
54505523
documentation_url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-finding
54515524
openapi_files:
54525525
- descriptions/api.github.com/api.github.com.json
5526+
- descriptions/ghec/ghec.json
54535527
- name: GET /repos/{owner}/{repo}/code-quality/setup
54545528
documentation_url: https://docs.github.com/rest/code-quality/code-quality#get-a-code-quality-setup-configuration
54555529
openapi_files:
54565530
- descriptions/api.github.com/api.github.com.json
5531+
- descriptions/ghec/ghec.json
54575532
- name: PATCH /repos/{owner}/{repo}/code-quality/setup
54585533
documentation_url: https://docs.github.com/rest/code-quality/code-quality#update-a-code-quality-setup-configuration
54595534
openapi_files:
54605535
- descriptions/api.github.com/api.github.com.json
5536+
- descriptions/ghec/ghec.json
54615537
- name: GET /repos/{owner}/{repo}/code-scanning/alerts
54625538
documentation_url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
54635539
openapi_files:
@@ -6411,6 +6487,16 @@ openapi_operations:
64116487
openapi_files:
64126488
- descriptions/api.github.com/api.github.com.json
64136489
- descriptions/ghec/ghec.json
6490+
- name: GET /repos/{owner}/{repo}/interaction-limits/pulls/creation-cap
6491+
documentation_url: https://docs.github.com/rest/interactions/repos#get-pull-request-creation-cap-for-a-repository
6492+
openapi_files:
6493+
- descriptions/api.github.com/api.github.com.json
6494+
- descriptions/ghec/ghec.json
6495+
- name: PATCH /repos/{owner}/{repo}/interaction-limits/pulls/creation-cap
6496+
documentation_url: https://docs.github.com/rest/interactions/repos#update-pull-request-creation-cap-for-a-repository
6497+
openapi_files:
6498+
- descriptions/api.github.com/api.github.com.json
6499+
- descriptions/ghec/ghec.json
64146500
- name: GET /repos/{owner}/{repo}/invitations
64156501
documentation_url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations
64166502
openapi_files:
@@ -7342,6 +7428,26 @@ openapi_operations:
73427428
- descriptions/api.github.com/api.github.com.json
73437429
- descriptions/ghec/ghec.json
73447430
- descriptions/ghes-3.21/ghes-3.21.json
7431+
- name: DELETE /repos/{owner}/{repo}/secret-scanning/custom-patterns
7432+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-delete-repository-custom-patterns
7433+
openapi_files:
7434+
- descriptions/api.github.com/api.github.com.json
7435+
- descriptions/ghec/ghec.json
7436+
- name: GET /repos/{owner}/{repo}/secret-scanning/custom-patterns
7437+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#list-repository-custom-patterns
7438+
openapi_files:
7439+
- descriptions/api.github.com/api.github.com.json
7440+
- descriptions/ghec/ghec.json
7441+
- name: POST /repos/{owner}/{repo}/secret-scanning/custom-patterns
7442+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#bulk-create-repository-custom-patterns
7443+
openapi_files:
7444+
- descriptions/api.github.com/api.github.com.json
7445+
- descriptions/ghec/ghec.json
7446+
- name: PATCH /repos/{owner}/{repo}/secret-scanning/custom-patterns/{pattern_id}
7447+
documentation_url: https://docs.github.com/rest/secret-scanning/custom-patterns#update-a-repository-custom-pattern
7448+
openapi_files:
7449+
- descriptions/api.github.com/api.github.com.json
7450+
- descriptions/ghec/ghec.json
73457451
- name: POST /repos/{owner}/{repo}/secret-scanning/push-protection-bypasses
73467452
documentation_url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass
73477453
openapi_files:

0 commit comments

Comments
 (0)