@octokit/openapi 13.1.0 → 13.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "13.1.0",
4
+ "version": "13.2.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -37219,7 +37219,7 @@
37219
37219
  "operationId": "repos/list-webhooks",
37220
37220
  "externalDocs": {
37221
37221
  "description": "API method documentation",
37222
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#list-repository-webhooks"
37222
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#list-repository-webhooks"
37223
37223
  },
37224
37224
  "parameters": [
37225
37225
  {
@@ -37266,8 +37266,8 @@
37266
37266
  "x-github": {
37267
37267
  "githubCloudOnly": false,
37268
37268
  "enabledForGitHubApps": true,
37269
- "category": "webhooks",
37270
- "subcategory": "repos"
37269
+ "category": "repos",
37270
+ "subcategory": "webhooks"
37271
37271
  },
37272
37272
  "x-octokit": {}
37273
37273
  },
@@ -37280,7 +37280,7 @@
37280
37280
  "operationId": "repos/create-webhook",
37281
37281
  "externalDocs": {
37282
37282
  "description": "API method documentation",
37283
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#create-a-repository-webhook"
37283
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#create-a-repository-webhook"
37284
37284
  },
37285
37285
  "parameters": [
37286
37286
  {
@@ -37403,8 +37403,8 @@
37403
37403
  "x-github": {
37404
37404
  "githubCloudOnly": false,
37405
37405
  "enabledForGitHubApps": true,
37406
- "category": "webhooks",
37407
- "subcategory": "repos"
37406
+ "category": "repos",
37407
+ "subcategory": "webhooks"
37408
37408
  },
37409
37409
  "x-octokit": {}
37410
37410
  }
@@ -37419,7 +37419,7 @@
37419
37419
  "operationId": "repos/get-webhook",
37420
37420
  "externalDocs": {
37421
37421
  "description": "API method documentation",
37422
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#get-a-repository-webhook"
37422
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-repository-webhook"
37423
37423
  },
37424
37424
  "parameters": [
37425
37425
  {
@@ -37455,8 +37455,8 @@
37455
37455
  "x-github": {
37456
37456
  "githubCloudOnly": false,
37457
37457
  "enabledForGitHubApps": true,
37458
- "category": "webhooks",
37459
- "subcategory": "repos"
37458
+ "category": "repos",
37459
+ "subcategory": "webhooks"
37460
37460
  },
37461
37461
  "x-octokit": {}
37462
37462
  },
@@ -37469,7 +37469,7 @@
37469
37469
  "operationId": "repos/update-webhook",
37470
37470
  "externalDocs": {
37471
37471
  "description": "API method documentation",
37472
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#update-a-repository-webhook"
37472
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#update-a-repository-webhook"
37473
37473
  },
37474
37474
  "parameters": [
37475
37475
  {
@@ -37588,8 +37588,8 @@
37588
37588
  "x-github": {
37589
37589
  "githubCloudOnly": false,
37590
37590
  "enabledForGitHubApps": true,
37591
- "category": "webhooks",
37592
- "subcategory": "repos"
37591
+ "category": "repos",
37592
+ "subcategory": "webhooks"
37593
37593
  },
37594
37594
  "x-octokit": {}
37595
37595
  },
@@ -37602,7 +37602,7 @@
37602
37602
  "operationId": "repos/delete-webhook",
37603
37603
  "externalDocs": {
37604
37604
  "description": "API method documentation",
37605
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#delete-a-repository-webhook"
37605
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#delete-a-repository-webhook"
37606
37606
  },
37607
37607
  "parameters": [
37608
37608
  {
@@ -37626,8 +37626,8 @@
37626
37626
  "x-github": {
37627
37627
  "githubCloudOnly": false,
37628
37628
  "enabledForGitHubApps": true,
37629
- "category": "webhooks",
37630
- "subcategory": "repos"
37629
+ "category": "repos",
37630
+ "subcategory": "webhooks"
37631
37631
  },
37632
37632
  "x-octokit": {}
37633
37633
  }
@@ -37642,7 +37642,7 @@
37642
37642
  "operationId": "repos/get-webhook-config-for-repo",
37643
37643
  "externalDocs": {
37644
37644
  "description": "API method documentation",
37645
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
37645
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
37646
37646
  },
37647
37647
  "parameters": [
37648
37648
  {
@@ -37675,8 +37675,8 @@
37675
37675
  "x-github": {
37676
37676
  "githubCloudOnly": false,
37677
37677
  "enabledForGitHubApps": true,
37678
- "category": "webhooks",
37679
- "subcategory": "repo-config"
37678
+ "category": "repos",
37679
+ "subcategory": "webhooks"
37680
37680
  },
37681
37681
  "x-octokit": {}
37682
37682
  },
@@ -37689,7 +37689,7 @@
37689
37689
  "operationId": "repos/update-webhook-config-for-repo",
37690
37690
  "externalDocs": {
37691
37691
  "description": "API method documentation",
37692
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
37692
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
37693
37693
  },
37694
37694
  "parameters": [
37695
37695
  {
@@ -37756,8 +37756,8 @@
37756
37756
  "x-github": {
37757
37757
  "githubCloudOnly": false,
37758
37758
  "enabledForGitHubApps": true,
37759
- "category": "webhooks",
37760
- "subcategory": "repo-config"
37759
+ "category": "repos",
37760
+ "subcategory": "webhooks"
37761
37761
  },
37762
37762
  "x-octokit": {}
37763
37763
  }
@@ -37772,7 +37772,7 @@
37772
37772
  "operationId": "repos/list-webhook-deliveries",
37773
37773
  "externalDocs": {
37774
37774
  "description": "API method documentation",
37775
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
37775
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
37776
37776
  },
37777
37777
  "parameters": [
37778
37778
  {
@@ -37828,8 +37828,8 @@
37828
37828
  "x-github": {
37829
37829
  "githubCloudOnly": false,
37830
37830
  "enabledForGitHubApps": true,
37831
- "category": "webhooks",
37832
- "subcategory": "repo-deliveries"
37831
+ "category": "repos",
37832
+ "subcategory": "webhooks"
37833
37833
  },
37834
37834
  "x-octokit": {}
37835
37835
  }
@@ -37844,7 +37844,7 @@
37844
37844
  "operationId": "repos/get-webhook-delivery",
37845
37845
  "externalDocs": {
37846
37846
  "description": "API method documentation",
37847
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
37847
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
37848
37848
  },
37849
37849
  "parameters": [
37850
37850
  {
@@ -37886,8 +37886,8 @@
37886
37886
  "x-github": {
37887
37887
  "githubCloudOnly": false,
37888
37888
  "enabledForGitHubApps": true,
37889
- "category": "webhooks",
37890
- "subcategory": "repo-deliveries"
37889
+ "category": "repos",
37890
+ "subcategory": "webhooks"
37891
37891
  },
37892
37892
  "x-octokit": {}
37893
37893
  }
@@ -37902,7 +37902,7 @@
37902
37902
  "operationId": "repos/redeliver-webhook-delivery",
37903
37903
  "externalDocs": {
37904
37904
  "description": "API method documentation",
37905
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
37905
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
37906
37906
  },
37907
37907
  "parameters": [
37908
37908
  {
@@ -37932,8 +37932,8 @@
37932
37932
  "x-github": {
37933
37933
  "githubCloudOnly": false,
37934
37934
  "enabledForGitHubApps": true,
37935
- "category": "webhooks",
37936
- "subcategory": "repo-deliveries"
37935
+ "category": "repos",
37936
+ "subcategory": "webhooks"
37937
37937
  },
37938
37938
  "x-octokit": {}
37939
37939
  }
@@ -37948,7 +37948,7 @@
37948
37948
  "operationId": "repos/ping-webhook",
37949
37949
  "externalDocs": {
37950
37950
  "description": "API method documentation",
37951
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#ping-a-repository-webhook"
37951
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#ping-a-repository-webhook"
37952
37952
  },
37953
37953
  "parameters": [
37954
37954
  {
@@ -37972,8 +37972,8 @@
37972
37972
  "x-github": {
37973
37973
  "githubCloudOnly": false,
37974
37974
  "enabledForGitHubApps": true,
37975
- "category": "webhooks",
37976
- "subcategory": "repos"
37975
+ "category": "repos",
37976
+ "subcategory": "webhooks"
37977
37977
  },
37978
37978
  "x-octokit": {}
37979
37979
  }
@@ -37988,7 +37988,7 @@
37988
37988
  "operationId": "repos/test-push-webhook",
37989
37989
  "externalDocs": {
37990
37990
  "description": "API method documentation",
37991
- "url": "https://docs.github.com/enterprise-server@3.8/rest/webhooks/repos#test-the-push-repository-webhook"
37991
+ "url": "https://docs.github.com/enterprise-server@3.8/rest/repos/webhooks#test-the-push-repository-webhook"
37992
37992
  },
37993
37993
  "parameters": [
37994
37994
  {
@@ -38012,8 +38012,8 @@
38012
38012
  "x-github": {
38013
38013
  "githubCloudOnly": false,
38014
38014
  "enabledForGitHubApps": true,
38015
- "category": "webhooks",
38016
- "subcategory": "repos"
38015
+ "category": "repos",
38016
+ "subcategory": "webhooks"
38017
38017
  },
38018
38018
  "x-octokit": {}
38019
38019
  }
@@ -41410,6 +41410,9 @@
41410
41410
  }
41411
41411
  }
41412
41412
  }
41413
+ },
41414
+ "404": {
41415
+ "$ref": "#/components/responses/not_found"
41413
41416
  }
41414
41417
  },
41415
41418
  "x-github": {
@@ -73452,7 +73455,7 @@
73452
73455
  "pull-request-edited": {
73453
73456
  "post": {
73454
73457
  "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/enterprise-server@3.8/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.8/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.8/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
73455
- "description": "The title or body of a pull request was edited.",
73458
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
73456
73459
  "operationId": "pull-request/edited",
73457
73460
  "externalDocs": {
73458
73461
  "url": "https://docs.github.com/enterprise-server@3.8/webhooks/webhook-events-and-payloads#pull_request"
@@ -94838,7 +94841,8 @@
94838
94841
  "enum": [
94839
94842
  "queued",
94840
94843
  "in_progress",
94841
- "completed"
94844
+ "completed",
94845
+ "waiting"
94842
94846
  ]
94843
94847
  },
94844
94848
  "conclusion": {
@@ -269398,7 +269402,6 @@
269398
269402
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
269399
269403
  "svn_url": "https://svn.github.com/octocat/Hello-World",
269400
269404
  "homepage": "https://github.com",
269401
- "language": null,
269402
269405
  "forks_count": 9,
269403
269406
  "forks": 9,
269404
269407
  "stargazers_count": 80,
@@ -269783,7 +269786,6 @@
269783
269786
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
269784
269787
  "svn_url": "https://svn.github.com/octocat/Hello-World",
269785
269788
  "homepage": "https://github.com",
269786
- "language": null,
269787
269789
  "forks_count": 9,
269788
269790
  "stargazers_count": 80,
269789
269791
  "watchers_count": 80,
@@ -280887,16 +280889,10 @@
280887
280889
  "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
280888
280890
  "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
280889
280891
  "state": "open",
280890
- "resolution": null,
280891
- "resolved_at": null,
280892
- "resolved_by": null,
280893
280892
  "secret_type": "mailchimp_api_key",
280894
280893
  "secret_type_display_name": "Mailchimp API Key",
280895
280894
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
280896
- "push_protection_bypassed_by": null,
280897
- "push_protection_bypassed": false,
280898
- "push_protection_bypassed_at": null,
280899
- "resolution_comment": null
280895
+ "push_protection_bypassed": false
280900
280896
  }
280901
280897
  },
280902
280898
  "secret-scanning-alert-resolved": {
@@ -280933,8 +280929,6 @@
280933
280929
  "secret_type_display_name": "Mailchimp API Key",
280934
280930
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
280935
280931
  "push_protection_bypassed": false,
280936
- "push_protection_bypassed_by": null,
280937
- "push_protection_bypassed_at": null,
280938
280932
  "resolution_comment": "Example comment"
280939
280933
  }
280940
280934
  },