@octokit/openapi 6.2.1 → 6.4.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.
Files changed (28) hide show
  1. package/generated/api.github.com.deref.json +7689 -7772
  2. package/generated/api.github.com.json +1344 -1295
  3. package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
  4. package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
  5. package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +50 -3
  6. package/generated/ghes-3.2-diff-to-ghes-3.3.json +53 -3
  7. package/generated/ghes-3.2.deref.json +73 -7
  8. package/generated/ghes-3.2.json +89 -28
  9. package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +31 -4
  10. package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +96 -1
  11. package/generated/ghes-3.3-diff-to-ghes-3.4.json +92 -1
  12. package/generated/ghes-3.3.deref.json +76 -10
  13. package/generated/ghes-3.3.json +92 -31
  14. package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
  15. package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
  16. package/generated/ghes-3.4.deref.json +97 -19
  17. package/generated/ghes-3.4.json +105 -40
  18. package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +71 -25
  19. package/generated/ghes-3.5-diff-to-api.github.com.deref.json +328 -574
  20. package/generated/ghes-3.5-diff-to-api.github.com.json +206 -272
  21. package/generated/ghes-3.5.deref.json +115 -52
  22. package/generated/ghes-3.5.json +131 -77
  23. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +97 -4
  24. package/generated/github.ae-diff-to-api.github.com.deref.json +423 -1
  25. package/generated/github.ae-diff-to-api.github.com.json +294 -12
  26. package/generated/github.ae.deref.json +92 -119
  27. package/generated/github.ae.json +118 -95
  28. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.2.1",
4
+ "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.2.1",
4
+ "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.2.1",
4
+ "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -2466,7 +2466,6 @@
2466
2466
  "200": {
2467
2467
  "description": "Response",
2468
2468
  "content": {
2469
- "application/json+sarif": { "schema": { "type": "string" } },
2470
2469
  "application/json": {
2471
2470
  "schema": {
2472
2471
  "type": "object",
@@ -2573,7 +2572,7 @@
2573
2572
  },
2574
2573
  "examples": {
2575
2574
  "response": {
2576
- "summary": "Default response",
2575
+ "summary": "application/json response",
2577
2576
  "value": {
2578
2577
  "ref": "refs/heads/main",
2579
2578
  "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -2597,6 +2596,54 @@
2597
2596
  }
2598
2597
  }
2599
2598
  }
2599
+ },
2600
+ "application/json+sarif": {
2601
+ "schema": { "type": "object", "additionalProperties": true },
2602
+ "examples": {
2603
+ "response": {
2604
+ "summary": "application/json+sarif response",
2605
+ "value": {
2606
+ "runs": [
2607
+ {
2608
+ "tool": {
2609
+ "driver": {
2610
+ "name": "CodeQL",
2611
+ "organization": "GitHub",
2612
+ "semanticVersion": "1.0.0",
2613
+ "rules": [
2614
+ {
2615
+ "id": "js/unused-local-variable",
2616
+ "name": "js/unused-local-variable"
2617
+ }
2618
+ ]
2619
+ }
2620
+ },
2621
+ "results": [
2622
+ {
2623
+ "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
2624
+ "message": { "text": "Unused variable foo." },
2625
+ "locations": [
2626
+ {
2627
+ "physicalLocation": {
2628
+ "artifactLocation": { "uri": "file1.js" },
2629
+ "region": { "startLine": 1 }
2630
+ }
2631
+ }
2632
+ ],
2633
+ "ruleId": "js/unused-local-variable",
2634
+ "properties": [
2635
+ { "github/alertNumber": 2 },
2636
+ {
2637
+ "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
2638
+ }
2639
+ ]
2640
+ }
2641
+ ]
2642
+ }
2643
+ ]
2644
+ }
2645
+ }
2646
+ }
2600
2647
  }
2601
2648
  }
2602
2649
  },
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.2.1",
4
+ "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -717,7 +717,6 @@
717
717
  "200": {
718
718
  "description": "Response",
719
719
  "content": {
720
- "application/json+sarif": { "schema": { "type": "string" } },
721
720
  "application/json": {
722
721
  "schema": {
723
722
  "$ref": "#/components/schemas/code-scanning-analysis"
@@ -727,6 +726,14 @@
727
726
  "$ref": "#/components/examples/code-scanning-analysis-default"
728
727
  }
729
728
  }
729
+ },
730
+ "application/json+sarif": {
731
+ "schema": { "type": "object", "additionalProperties": true },
732
+ "examples": {
733
+ "response": {
734
+ "$ref": "#/components/examples/code-scanning-analysis-sarif"
735
+ }
736
+ }
730
737
  }
731
738
  }
732
739
  },
@@ -2775,7 +2782,7 @@
2775
2782
  ]
2776
2783
  },
2777
2784
  "code-scanning-analysis-default": {
2778
- "summary": "Default response",
2785
+ "summary": "application/json response",
2779
2786
  "value": {
2780
2787
  "ref": "refs/heads/main",
2781
2788
  "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -2794,6 +2801,49 @@
2794
2801
  "warning": ""
2795
2802
  }
2796
2803
  },
2804
+ "code-scanning-analysis-sarif": {
2805
+ "summary": "application/json+sarif response",
2806
+ "value": {
2807
+ "runs": [
2808
+ {
2809
+ "tool": {
2810
+ "driver": {
2811
+ "name": "CodeQL",
2812
+ "organization": "GitHub",
2813
+ "semanticVersion": "1.0.0",
2814
+ "rules": [
2815
+ {
2816
+ "id": "js/unused-local-variable",
2817
+ "name": "js/unused-local-variable"
2818
+ }
2819
+ ]
2820
+ }
2821
+ },
2822
+ "results": [
2823
+ {
2824
+ "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
2825
+ "message": { "text": "Unused variable foo." },
2826
+ "locations": [
2827
+ {
2828
+ "physicalLocation": {
2829
+ "artifactLocation": { "uri": "file1.js" },
2830
+ "region": { "startLine": 1 }
2831
+ }
2832
+ }
2833
+ ],
2834
+ "ruleId": "js/unused-local-variable",
2835
+ "properties": [
2836
+ { "github/alertNumber": 2 },
2837
+ {
2838
+ "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
2839
+ }
2840
+ ]
2841
+ }
2842
+ ]
2843
+ }
2844
+ ]
2845
+ }
2846
+ },
2797
2847
  "reaction": {
2798
2848
  "value": {
2799
2849
  "id": 1,
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "6.2.1",
4
+ "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -53860,7 +53860,7 @@
53860
53860
  "selected_repository_ids": {
53861
53861
  "type": "array",
53862
53862
  "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
53863
- "items": { "type": "string" }
53863
+ "items": { "type": "integer" }
53864
53864
  }
53865
53865
  },
53866
53866
  "required": ["visibility"]
@@ -53871,7 +53871,7 @@
53871
53871
  "encrypted_value": "c2VjcmV0",
53872
53872
  "key_id": "012345678912345678",
53873
53873
  "visibility": "selected",
53874
- "selected_repository_ids": ["1296269", "1296280"]
53874
+ "selected_repository_ids": [1296269, 1296280]
53875
53875
  }
53876
53876
  }
53877
53877
  }
@@ -135098,7 +135098,6 @@
135098
135098
  "200": {
135099
135099
  "description": "Response",
135100
135100
  "content": {
135101
- "application/json+sarif": { "schema": { "type": "string" } },
135102
135101
  "application/json": {
135103
135102
  "schema": {
135104
135103
  "type": "object",
@@ -135205,7 +135204,7 @@
135205
135204
  },
135206
135205
  "examples": {
135207
135206
  "response": {
135208
- "summary": "Default response",
135207
+ "summary": "application/json response",
135209
135208
  "value": {
135210
135209
  "ref": "refs/heads/main",
135211
135210
  "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -135229,6 +135228,54 @@
135229
135228
  }
135230
135229
  }
135231
135230
  }
135231
+ },
135232
+ "application/json+sarif": {
135233
+ "schema": { "type": "object", "additionalProperties": true },
135234
+ "examples": {
135235
+ "response": {
135236
+ "summary": "application/json+sarif response",
135237
+ "value": {
135238
+ "runs": [
135239
+ {
135240
+ "tool": {
135241
+ "driver": {
135242
+ "name": "CodeQL",
135243
+ "organization": "GitHub",
135244
+ "semanticVersion": "1.0.0",
135245
+ "rules": [
135246
+ {
135247
+ "id": "js/unused-local-variable",
135248
+ "name": "js/unused-local-variable"
135249
+ }
135250
+ ]
135251
+ }
135252
+ },
135253
+ "results": [
135254
+ {
135255
+ "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
135256
+ "message": { "text": "Unused variable foo." },
135257
+ "locations": [
135258
+ {
135259
+ "physicalLocation": {
135260
+ "artifactLocation": { "uri": "file1.js" },
135261
+ "region": { "startLine": 1 }
135262
+ }
135263
+ }
135264
+ ],
135265
+ "ruleId": "js/unused-local-variable",
135266
+ "properties": [
135267
+ { "github/alertNumber": 2 },
135268
+ {
135269
+ "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
135270
+ }
135271
+ ]
135272
+ }
135273
+ ]
135274
+ }
135275
+ ]
135276
+ }
135277
+ }
135278
+ }
135232
135279
  }
135233
135280
  }
135234
135281
  },
@@ -135530,6 +135577,15 @@
135530
135577
  }
135531
135578
  },
135532
135579
  "required": ["commit_sha", "ref", "sarif"]
135580
+ },
135581
+ "examples": {
135582
+ "default": {
135583
+ "value": {
135584
+ "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
135585
+ "ref": "refs/heads/master",
135586
+ "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
135587
+ }
135588
+ }
135533
135589
  }
135534
135590
  }
135535
135591
  }
@@ -196176,7 +196232,7 @@
196176
196232
  "operationId": "issues/remove-assignees",
196177
196233
  "externalDocs": {
196178
196234
  "description": "API method documentation",
196179
- "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#remove-assignees-from-an-issue"
196235
+ "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
196180
196236
  },
196181
196237
  "parameters": [
196182
196238
  {
@@ -196202,6 +196258,7 @@
196202
196258
  }
196203
196259
  ],
196204
196260
  "requestBody": {
196261
+ "required": true,
196205
196262
  "content": {
196206
196263
  "application/json": {
196207
196264
  "schema": {
@@ -196212,7 +196269,8 @@
196212
196269
  "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
196213
196270
  "items": { "type": "string" }
196214
196271
  }
196215
- }
196272
+ },
196273
+ "required": ["assignees"]
196216
196274
  },
196217
196275
  "examples": {
196218
196276
  "default": { "value": { "assignees": ["hubot", "other_user"] } }
@@ -197643,6 +197701,9 @@
197643
197701
  "allow_auto_merge": { "type": "boolean" },
197644
197702
  "delete_branch_on_merge": { "type": "boolean" },
197645
197703
  "allow_update_branch": { "type": "boolean" },
197704
+ "use_squash_pr_title_as_default": {
197705
+ "type": "boolean"
197706
+ },
197646
197707
  "allow_merge_commit": { "type": "boolean" },
197647
197708
  "subscribers_count": { "type": "integer" },
197648
197709
  "network_count": { "type": "integer" }
@@ -197673,6 +197734,11 @@
197673
197734
  "type": "boolean",
197674
197735
  "example": false
197675
197736
  },
197737
+ "use_squash_pr_title_as_default": {
197738
+ "type": "boolean",
197739
+ "description": "Whether a squash merge commit can use the pull request title as default.",
197740
+ "default": false
197741
+ },
197676
197742
  "allow_merge_commit": {
197677
197743
  "description": "Whether to allow merge commits for pull requests.",
197678
197744
  "default": true,