@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": {
@@ -135441,7 +135441,6 @@
135441
135441
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
135442
135442
  "svn_url": "https://svn.github.com/octocat/Hello-World",
135443
135443
  "homepage": "https://github.com",
135444
- "language": null,
135445
135444
  "forks_count": 9,
135446
135445
  "forks": 9,
135447
135446
  "stargazers_count": 80,
@@ -135826,7 +135825,6 @@
135826
135825
  "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
135827
135826
  "svn_url": "https://svn.github.com/octocat/Hello-World",
135828
135827
  "homepage": "https://github.com",
135829
- "language": null,
135830
135828
  "forks_count": 9,
135831
135829
  "stargazers_count": 80,
135832
135830
  "watchers_count": 80,
@@ -142782,7 +142780,8 @@
142782
142780
  "enum": [
142783
142781
  "queued",
142784
142782
  "in_progress",
142785
- "completed"
142783
+ "completed",
142784
+ "waiting"
142786
142785
  ]
142787
142786
  },
142788
142787
  "conclusion": {
@@ -156011,7 +156010,8 @@
156011
156010
  "enum": [
156012
156011
  "queued",
156013
156012
  "in_progress",
156014
- "completed"
156013
+ "completed",
156014
+ "waiting"
156015
156015
  ]
156016
156016
  },
156017
156017
  "conclusion": {
@@ -156659,7 +156659,8 @@
156659
156659
  "enum": [
156660
156660
  "queued",
156661
156661
  "in_progress",
156662
- "completed"
156662
+ "completed",
156663
+ "waiting"
156663
156664
  ]
156664
156665
  },
156665
156666
  "conclusion": {
@@ -240023,7 +240024,7 @@
240023
240024
  "operationId": "repos/list-webhooks",
240024
240025
  "externalDocs": {
240025
240026
  "description": "API method documentation",
240026
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#list-repository-webhooks"
240027
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#list-repository-webhooks"
240027
240028
  },
240028
240029
  "parameters": [
240029
240030
  {
@@ -240304,8 +240305,8 @@
240304
240305
  "x-github": {
240305
240306
  "githubCloudOnly": false,
240306
240307
  "enabledForGitHubApps": true,
240307
- "category": "webhooks",
240308
- "subcategory": "repos"
240308
+ "category": "repos",
240309
+ "subcategory": "webhooks"
240309
240310
  },
240310
240311
  "x-octokit": {}
240311
240312
  },
@@ -240318,7 +240319,7 @@
240318
240319
  "operationId": "repos/create-webhook",
240319
240320
  "externalDocs": {
240320
240321
  "description": "API method documentation",
240321
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#create-a-repository-webhook"
240322
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#create-a-repository-webhook"
240322
240323
  },
240323
240324
  "parameters": [
240324
240325
  {
@@ -240763,8 +240764,8 @@
240763
240764
  "x-github": {
240764
240765
  "githubCloudOnly": false,
240765
240766
  "enabledForGitHubApps": true,
240766
- "category": "webhooks",
240767
- "subcategory": "repos"
240767
+ "category": "repos",
240768
+ "subcategory": "webhooks"
240768
240769
  },
240769
240770
  "x-octokit": {}
240770
240771
  }
@@ -240779,7 +240780,7 @@
240779
240780
  "operationId": "repos/get-webhook",
240780
240781
  "externalDocs": {
240781
240782
  "description": "API method documentation",
240782
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#get-a-repository-webhook"
240783
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-repository-webhook"
240783
240784
  },
240784
240785
  "parameters": [
240785
240786
  {
@@ -241038,8 +241039,8 @@
241038
241039
  "x-github": {
241039
241040
  "githubCloudOnly": false,
241040
241041
  "enabledForGitHubApps": true,
241041
- "category": "webhooks",
241042
- "subcategory": "repos"
241042
+ "category": "repos",
241043
+ "subcategory": "webhooks"
241043
241044
  },
241044
241045
  "x-octokit": {}
241045
241046
  },
@@ -241052,7 +241053,7 @@
241052
241053
  "operationId": "repos/update-webhook",
241053
241054
  "externalDocs": {
241054
241055
  "description": "API method documentation",
241055
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#update-a-repository-webhook"
241056
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-repository-webhook"
241056
241057
  },
241057
241058
  "parameters": [
241058
241059
  {
@@ -241476,8 +241477,8 @@
241476
241477
  "x-github": {
241477
241478
  "githubCloudOnly": false,
241478
241479
  "enabledForGitHubApps": true,
241479
- "category": "webhooks",
241480
- "subcategory": "repos"
241480
+ "category": "repos",
241481
+ "subcategory": "webhooks"
241481
241482
  },
241482
241483
  "x-octokit": {}
241483
241484
  },
@@ -241490,7 +241491,7 @@
241490
241491
  "operationId": "repos/delete-webhook",
241491
241492
  "externalDocs": {
241492
241493
  "description": "API method documentation",
241493
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#delete-a-repository-webhook"
241494
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#delete-a-repository-webhook"
241494
241495
  },
241495
241496
  "parameters": [
241496
241497
  {
@@ -241555,8 +241556,8 @@
241555
241556
  "x-github": {
241556
241557
  "githubCloudOnly": false,
241557
241558
  "enabledForGitHubApps": true,
241558
- "category": "webhooks",
241559
- "subcategory": "repos"
241559
+ "category": "repos",
241560
+ "subcategory": "webhooks"
241560
241561
  },
241561
241562
  "x-octokit": {}
241562
241563
  }
@@ -241571,7 +241572,7 @@
241571
241572
  "operationId": "repos/get-webhook-config-for-repo",
241572
241573
  "externalDocs": {
241573
241574
  "description": "API method documentation",
241574
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
241575
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
241575
241576
  },
241576
241577
  "parameters": [
241577
241578
  {
@@ -241659,8 +241660,8 @@
241659
241660
  "x-github": {
241660
241661
  "githubCloudOnly": false,
241661
241662
  "enabledForGitHubApps": true,
241662
- "category": "webhooks",
241663
- "subcategory": "repo-config"
241663
+ "category": "repos",
241664
+ "subcategory": "webhooks"
241664
241665
  },
241665
241666
  "x-octokit": {}
241666
241667
  },
@@ -241673,7 +241674,7 @@
241673
241674
  "operationId": "repos/update-webhook-config-for-repo",
241674
241675
  "externalDocs": {
241675
241676
  "description": "API method documentation",
241676
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
241677
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
241677
241678
  },
241678
241679
  "parameters": [
241679
241680
  {
@@ -241811,8 +241812,8 @@
241811
241812
  "x-github": {
241812
241813
  "githubCloudOnly": false,
241813
241814
  "enabledForGitHubApps": true,
241814
- "category": "webhooks",
241815
- "subcategory": "repo-config"
241815
+ "category": "repos",
241816
+ "subcategory": "webhooks"
241816
241817
  },
241817
241818
  "x-octokit": {}
241818
241819
  }
@@ -241827,7 +241828,7 @@
241827
241828
  "operationId": "repos/list-webhook-deliveries",
241828
241829
  "externalDocs": {
241829
241830
  "description": "API method documentation",
241830
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
241831
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
241831
241832
  },
241832
241833
  "parameters": [
241833
241834
  {
@@ -242139,8 +242140,8 @@
242139
242140
  "x-github": {
242140
242141
  "githubCloudOnly": false,
242141
242142
  "enabledForGitHubApps": true,
242142
- "category": "webhooks",
242143
- "subcategory": "repo-deliveries"
242143
+ "category": "repos",
242144
+ "subcategory": "webhooks"
242144
242145
  },
242145
242146
  "x-octokit": {}
242146
242147
  }
@@ -242155,7 +242156,7 @@
242155
242156
  "operationId": "repos/get-webhook-delivery",
242156
242157
  "externalDocs": {
242157
242158
  "description": "API method documentation",
242158
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
242159
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
242159
242160
  },
242160
242161
  "parameters": [
242161
242162
  {
@@ -242510,8 +242511,8 @@
242510
242511
  "x-github": {
242511
242512
  "githubCloudOnly": false,
242512
242513
  "enabledForGitHubApps": true,
242513
- "category": "webhooks",
242514
- "subcategory": "repo-deliveries"
242514
+ "category": "repos",
242515
+ "subcategory": "webhooks"
242515
242516
  },
242516
242517
  "x-octokit": {}
242517
242518
  }
@@ -242526,7 +242527,7 @@
242526
242527
  "operationId": "repos/redeliver-webhook-delivery",
242527
242528
  "externalDocs": {
242528
242529
  "description": "API method documentation",
242529
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
242530
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
242530
242531
  },
242531
242532
  "parameters": [
242532
242533
  {
@@ -242714,8 +242715,8 @@
242714
242715
  "x-github": {
242715
242716
  "githubCloudOnly": false,
242716
242717
  "enabledForGitHubApps": true,
242717
- "category": "webhooks",
242718
- "subcategory": "repo-deliveries"
242718
+ "category": "repos",
242719
+ "subcategory": "webhooks"
242719
242720
  },
242720
242721
  "x-octokit": {}
242721
242722
  }
@@ -242730,7 +242731,7 @@
242730
242731
  "operationId": "repos/ping-webhook",
242731
242732
  "externalDocs": {
242732
242733
  "description": "API method documentation",
242733
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#ping-a-repository-webhook"
242734
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#ping-a-repository-webhook"
242734
242735
  },
242735
242736
  "parameters": [
242736
242737
  {
@@ -242795,8 +242796,8 @@
242795
242796
  "x-github": {
242796
242797
  "githubCloudOnly": false,
242797
242798
  "enabledForGitHubApps": true,
242798
- "category": "webhooks",
242799
- "subcategory": "repos"
242799
+ "category": "repos",
242800
+ "subcategory": "webhooks"
242800
242801
  },
242801
242802
  "x-octokit": {}
242802
242803
  }
@@ -242811,7 +242812,7 @@
242811
242812
  "operationId": "repos/test-push-webhook",
242812
242813
  "externalDocs": {
242813
242814
  "description": "API method documentation",
242814
- "url": "https://docs.github.com/enterprise-server@3.9/rest/webhooks/repos#test-the-push-repository-webhook"
242815
+ "url": "https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#test-the-push-repository-webhook"
242815
242816
  },
242816
242817
  "parameters": [
242817
242818
  {
@@ -242876,8 +242877,8 @@
242876
242877
  "x-github": {
242877
242878
  "githubCloudOnly": false,
242878
242879
  "enabledForGitHubApps": true,
242879
- "category": "webhooks",
242880
- "subcategory": "repos"
242880
+ "category": "repos",
242881
+ "subcategory": "webhooks"
242881
242882
  },
242882
242883
  "x-octokit": {}
242883
242884
  }
@@ -299755,6 +299756,32 @@
299755
299756
  }
299756
299757
  }
299757
299758
  }
299759
+ },
299760
+ "404": {
299761
+ "description": "Resource not found",
299762
+ "content": {
299763
+ "application/json": {
299764
+ "schema": {
299765
+ "title": "Basic Error",
299766
+ "description": "Basic Error",
299767
+ "type": "object",
299768
+ "properties": {
299769
+ "message": {
299770
+ "type": "string"
299771
+ },
299772
+ "documentation_url": {
299773
+ "type": "string"
299774
+ },
299775
+ "url": {
299776
+ "type": "string"
299777
+ },
299778
+ "status": {
299779
+ "type": "string"
299780
+ }
299781
+ }
299782
+ }
299783
+ }
299784
+ }
299758
299785
  }
299759
299786
  },
299760
299787
  "x-github": {
@@ -349597,16 +349624,10 @@
349597
349624
  "html_url": "https://github.com/owner/private-repo/security/secret-scanning/42",
349598
349625
  "locations_url": "https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations",
349599
349626
  "state": "open",
349600
- "resolution": null,
349601
- "resolved_at": null,
349602
- "resolved_by": null,
349603
349627
  "secret_type": "mailchimp_api_key",
349604
349628
  "secret_type_display_name": "Mailchimp API Key",
349605
349629
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
349606
- "push_protection_bypassed_by": null,
349607
- "push_protection_bypassed": false,
349608
- "push_protection_bypassed_at": null,
349609
- "resolution_comment": null
349630
+ "push_protection_bypassed": false
349610
349631
  }
349611
349632
  }
349612
349633
  }
@@ -350111,8 +350132,6 @@
350111
350132
  "secret_type_display_name": "Mailchimp API Key",
350112
350133
  "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2",
350113
350134
  "push_protection_bypassed": false,
350114
- "push_protection_bypassed_by": null,
350115
- "push_protection_bypassed_at": null,
350116
350135
  "resolution_comment": "Example comment"
350117
350136
  }
350118
350137
  }
@@ -748689,7 +748708,7 @@
748689
748708
  "pull-request-edited": {
748690
748709
  "post": {
748691
748710
  "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.9/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.9/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.9/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.",
748692
- "description": "The title or body of a pull request was edited.",
748711
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
748693
748712
  "operationId": "pull-request/edited",
748694
748713
  "externalDocs": {
748695
748714
  "url": "https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request"