@octokit/openapi 11.0.0 → 11.1.1

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.
Files changed (31) hide show
  1. package/generated/api.github.com.deref.json +7867 -1059
  2. package/generated/api.github.com.json +1150 -152
  3. package/generated/ghec-diff-to-api.github.com.deref.json +4944 -11
  4. package/generated/ghec-diff-to-api.github.com.json +92 -1
  5. package/generated/ghec.deref.json +7870 -1062
  6. package/generated/ghec.json +1153 -155
  7. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +0 -84
  8. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +292 -4865
  9. package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -675
  10. package/generated/ghes-3.5.deref.json +208 -60
  11. package/generated/ghes-3.5.json +21 -60
  12. package/generated/ghes-3.6-anicca-diff-to-ghes-3.7.deref.json +0 -48
  13. package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -4739
  14. package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -684
  15. package/generated/ghes-3.6.deref.json +44 -60
  16. package/generated/ghes-3.6.json +21 -60
  17. package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +252 -11
  18. package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
  19. package/generated/ghes-3.7.deref.json +282 -63
  20. package/generated/ghes-3.7.json +133 -63
  21. package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -38
  22. package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -4758
  23. package/generated/ghes-3.8-diff-to-api.github.com.json +1 -672
  24. package/generated/ghes-3.8.deref.json +433 -70
  25. package/generated/ghes-3.8.json +284 -70
  26. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -84
  27. package/generated/github.ae-diff-to-api.github.com.deref.json +13247 -12990
  28. package/generated/github.ae-diff-to-api.github.com.json +1351 -1935
  29. package/generated/github.ae.deref.json +5201 -73
  30. package/generated/github.ae.json +424 -73
  31. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.0.0",
4
+ "version": "11.1.1",
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": {
@@ -42798,7 +42798,7 @@
42798
42798
  "operationId": "gists/update",
42799
42799
  "externalDocs": {
42800
42800
  "description": "API method documentation",
42801
- "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/gists/#update-a-gist"
42801
+ "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
42802
42802
  },
42803
42803
  "parameters": [
42804
42804
  {
@@ -42816,6 +42816,7 @@
42816
42816
  "content": {
42817
42817
  "application/json": {
42818
42818
  "schema": {
42819
+ "type": "object",
42819
42820
  "properties": {
42820
42821
  "description": {
42821
42822
  "description": "The description of the gist.",
@@ -42832,29 +42833,21 @@
42832
42833
  },
42833
42834
  "type": "object",
42834
42835
  "additionalProperties": {
42835
- "type": "object",
42836
- "nullable": true,
42837
- "properties": {
42838
- "content": {
42839
- "description": "The new content of the file.",
42840
- "type": "string"
42841
- },
42842
- "filename": {
42843
- "description": "The new filename for the file.",
42844
- "type": "string",
42845
- "nullable": true
42846
- }
42847
- },
42848
- "anyOf": [
42849
- {
42850
- "required": [
42851
- "content"
42852
- ]
42853
- },
42836
+ "oneOf": [
42854
42837
  {
42855
- "required": [
42856
- "filename"
42857
- ]
42838
+ "type": "object",
42839
+ "nullable": true,
42840
+ "properties": {
42841
+ "content": {
42842
+ "description": "The new content of the file.",
42843
+ "type": "string"
42844
+ },
42845
+ "filename": {
42846
+ "description": "The new filename for the file.",
42847
+ "type": "string",
42848
+ "nullable": true
42849
+ }
42850
+ }
42858
42851
  },
42859
42852
  {
42860
42853
  "type": "object",
@@ -42864,19 +42857,6 @@
42864
42857
  }
42865
42858
  }
42866
42859
  },
42867
- "anyOf": [
42868
- {
42869
- "required": [
42870
- "description"
42871
- ]
42872
- },
42873
- {
42874
- "required": [
42875
- "files"
42876
- ]
42877
- }
42878
- ],
42879
- "type": "object",
42880
42860
  "nullable": true
42881
42861
  },
42882
42862
  "examples": {
@@ -207231,7 +207211,7 @@
207231
207211
  "/repos/{owner}/{repo}/events": {
207232
207212
  "get": {
207233
207213
  "summary": "List repository events",
207234
- "description": "",
207214
+ "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n",
207235
207215
  "tags": [
207236
207216
  "activity"
207237
207217
  ],
@@ -307716,14 +307696,14 @@
307716
307696
  },
307717
307697
  "post": {
307718
307698
  "summary": "Request reviewers for a pull request",
307719
- "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
307699
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
307720
307700
  "tags": [
307721
307701
  "pulls"
307722
307702
  ],
307723
307703
  "operationId": "pulls/request-reviewers",
307724
307704
  "externalDocs": {
307725
307705
  "description": "API method documentation",
307726
- "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#request-reviewers-for-a-pull-request"
307706
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
307727
307707
  },
307728
307708
  "parameters": [
307729
307709
  {
@@ -307775,19 +307755,7 @@
307775
307755
  "type": "string"
307776
307756
  }
307777
307757
  }
307778
- },
307779
- "anyOf": [
307780
- {
307781
- "required": [
307782
- "reviewers"
307783
- ]
307784
- },
307785
- {
307786
- "required": [
307787
- "team_reviewers"
307788
- ]
307789
- }
307790
- ]
307758
+ }
307791
307759
  },
307792
307760
  "examples": {
307793
307761
  "default": {
@@ -308701,6 +308669,9 @@
308701
308669
  "privacy": {
308702
308670
  "type": "string"
308703
308671
  },
308672
+ "notification_setting": {
308673
+ "type": "string"
308674
+ },
308704
308675
  "permission": {
308705
308676
  "type": "string"
308706
308677
  },
@@ -308792,6 +308763,11 @@
308792
308763
  "type": "string",
308793
308764
  "example": "closed"
308794
308765
  },
308766
+ "notification_setting": {
308767
+ "description": "The notification setting the team has set",
308768
+ "type": "string",
308769
+ "example": "notifications_enabled"
308770
+ },
308795
308771
  "html_url": {
308796
308772
  "type": "string",
308797
308773
  "format": "uri",
@@ -309462,6 +309438,12 @@
309462
309438
  "type": "boolean",
309463
309439
  "example": true
309464
309440
  },
309441
+ "has_discussions": {
309442
+ "description": "Whether discussions are enabled.",
309443
+ "default": false,
309444
+ "type": "boolean",
309445
+ "example": true
309446
+ },
309465
309447
  "archived": {
309466
309448
  "description": "Whether the repository is archived.",
309467
309449
  "default": false,
@@ -310798,6 +310780,12 @@
310798
310780
  "type": "boolean",
310799
310781
  "example": true
310800
310782
  },
310783
+ "has_discussions": {
310784
+ "description": "Whether discussions are enabled.",
310785
+ "default": false,
310786
+ "type": "boolean",
310787
+ "example": true
310788
+ },
310801
310789
  "archived": {
310802
310790
  "description": "Whether the repository is archived.",
310803
310791
  "default": false,
@@ -312068,6 +312056,7 @@
312068
312056
  "slug": "justice-league",
312069
312057
  "description": "A great team.",
312070
312058
  "privacy": "closed",
312059
+ "notification_setting": "notifications_enabled",
312071
312060
  "permission": "admin",
312072
312061
  "members_url": "https://api.github.com/teams/1/members{/member}",
312073
312062
  "repositories_url": "https://api.github.com/teams/1/repos",
@@ -312397,6 +312386,7 @@
312397
312386
  }
312398
312387
  },
312399
312388
  "author_association": "OWNER",
312389
+ "auto_merge": null,
312400
312390
  "draft": false
312401
312391
  }
312402
312392
  }
@@ -312441,13 +312431,7 @@
312441
312431
  "category": "pulls",
312442
312432
  "subcategory": "review-requests"
312443
312433
  },
312444
- "x-octokit": {
312445
- "diff": {
312446
- "ghes-3.7": {
312447
- "type": "changed"
312448
- }
312449
- }
312450
- }
312434
+ "x-octokit": {}
312451
312435
  },
312452
312436
  "delete": {
312453
312437
  "summary": "Remove requested reviewers from a pull request",
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.0.0",
4
+ "version": "11.1.1",
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": {
@@ -7753,7 +7753,7 @@
7753
7753
  "operationId": "gists/update",
7754
7754
  "externalDocs": {
7755
7755
  "description": "API method documentation",
7756
- "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/gists/#update-a-gist"
7756
+ "url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
7757
7757
  },
7758
7758
  "parameters": [
7759
7759
  {
@@ -7765,6 +7765,7 @@
7765
7765
  "content": {
7766
7766
  "application/json": {
7767
7767
  "schema": {
7768
+ "type": "object",
7768
7769
  "properties": {
7769
7770
  "description": {
7770
7771
  "description": "The description of the gist.",
@@ -7781,29 +7782,20 @@
7781
7782
  },
7782
7783
  "type": "object",
7783
7784
  "additionalProperties": {
7784
- "type": "object",
7785
- "nullable": true,
7786
- "properties": {
7787
- "content": {
7788
- "description": "The new content of the file.",
7789
- "type": "string"
7790
- },
7791
- "filename": {
7792
- "description": "The new filename for the file.",
7793
- "type": "string",
7794
- "nullable": true
7795
- }
7796
- },
7797
- "anyOf": [
7798
- {
7799
- "required": [
7800
- "content"
7801
- ]
7802
- },
7785
+ "oneOf": [
7803
7786
  {
7804
- "required": [
7805
- "filename"
7806
- ]
7787
+ "type": "object",
7788
+ "properties": {
7789
+ "content": {
7790
+ "description": "The new content of the file.",
7791
+ "type": "string"
7792
+ },
7793
+ "filename": {
7794
+ "description": "The new filename for the file.",
7795
+ "type": "string",
7796
+ "nullable": true
7797
+ }
7798
+ }
7807
7799
  },
7808
7800
  {
7809
7801
  "type": "object",
@@ -7813,19 +7805,6 @@
7813
7805
  }
7814
7806
  }
7815
7807
  },
7816
- "anyOf": [
7817
- {
7818
- "required": [
7819
- "description"
7820
- ]
7821
- },
7822
- {
7823
- "required": [
7824
- "files"
7825
- ]
7826
- }
7827
- ],
7828
- "type": "object",
7829
7808
  "nullable": true
7830
7809
  },
7831
7810
  "examples": {
@@ -33055,7 +33034,7 @@
33055
33034
  "/repos/{owner}/{repo}/events": {
33056
33035
  "get": {
33057
33036
  "summary": "List repository events",
33058
- "description": "",
33037
+ "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n",
33059
33038
  "tags": [
33060
33039
  "activity"
33061
33040
  ],
@@ -42024,14 +42003,14 @@
42024
42003
  },
42025
42004
  "post": {
42026
42005
  "summary": "Request reviewers for a pull request",
42027
- "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
42006
+ "description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
42028
42007
  "tags": [
42029
42008
  "pulls"
42030
42009
  ],
42031
42010
  "operationId": "pulls/request-reviewers",
42032
42011
  "externalDocs": {
42033
42012
  "description": "API method documentation",
42034
- "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#request-reviewers-for-a-pull-request"
42013
+ "url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
42035
42014
  },
42036
42015
  "parameters": [
42037
42016
  {
@@ -42065,19 +42044,7 @@
42065
42044
  "type": "string"
42066
42045
  }
42067
42046
  }
42068
- },
42069
- "anyOf": [
42070
- {
42071
- "required": [
42072
- "reviewers"
42073
- ]
42074
- },
42075
- {
42076
- "required": [
42077
- "team_reviewers"
42078
- ]
42079
- }
42080
- ]
42047
+ }
42081
42048
  },
42082
42049
  "examples": {
42083
42050
  "default": {
@@ -42126,13 +42093,7 @@
42126
42093
  "category": "pulls",
42127
42094
  "subcategory": "review-requests"
42128
42095
  },
42129
- "x-octokit": {
42130
- "diff": {
42131
- "ghes-3.7": {
42132
- "type": "changed"
42133
- }
42134
- }
42135
- }
42096
+ "x-octokit": {}
42136
42097
  },
42137
42098
  "delete": {
42138
42099
  "summary": "Remove requested reviewers from a pull request",