@octokit/openapi 18.1.0 → 18.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": "18.1.0",
4
+ "version": "18.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": {
@@ -18611,6 +18611,15 @@
18611
18611
  {
18612
18612
  "$ref": "#/components/parameters/labels"
18613
18613
  },
18614
+ {
18615
+ "name": "type",
18616
+ "description": "Can be the name of an issue type.",
18617
+ "in": "query",
18618
+ "required": false,
18619
+ "schema": {
18620
+ "type": "string"
18621
+ }
18622
+ },
18614
18623
  {
18615
18624
  "name": "sort",
18616
18625
  "description": "What to sort results by.",
@@ -20196,6 +20205,9 @@
20196
20205
  },
20197
20206
  {
20198
20207
  "$ref": "#/components/parameters/personal-access-token-after"
20208
+ },
20209
+ {
20210
+ "$ref": "#/components/parameters/personal-access-token-token-id"
20199
20211
  }
20200
20212
  ],
20201
20213
  "responses": {
@@ -20543,6 +20555,9 @@
20543
20555
  },
20544
20556
  {
20545
20557
  "$ref": "#/components/parameters/personal-access-token-after"
20558
+ },
20559
+ {
20560
+ "$ref": "#/components/parameters/personal-access-token-token-id"
20546
20561
  }
20547
20562
  ],
20548
20563
  "responses": {
@@ -40882,7 +40897,7 @@
40882
40897
  },
40883
40898
  "post": {
40884
40899
  "summary": "Create a custom deployment protection rule on an environment",
40885
- "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.12/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
40900
+ "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.12/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.12/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
40886
40901
  "tags": [
40887
40902
  "repos"
40888
40903
  ],
@@ -44130,6 +44145,15 @@
44130
44145
  "type": "string"
44131
44146
  }
44132
44147
  },
44148
+ {
44149
+ "name": "type",
44150
+ "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.",
44151
+ "in": "query",
44152
+ "required": false,
44153
+ "schema": {
44154
+ "type": "string"
44155
+ }
44156
+ },
44133
44157
  {
44134
44158
  "name": "creator",
44135
44159
  "description": "The user that created the issue.",
@@ -44315,6 +44339,12 @@
44315
44339
  "items": {
44316
44340
  "type": "string"
44317
44341
  }
44342
+ },
44343
+ "type": {
44344
+ "type": "string",
44345
+ "description": "The name of the issue type to associate with this issue.",
44346
+ "nullable": true,
44347
+ "example": "Epic"
44318
44348
  }
44319
44349
  },
44320
44350
  "required": [
@@ -45170,6 +45200,12 @@
45170
45200
  "items": {
45171
45201
  "type": "string"
45172
45202
  }
45203
+ },
45204
+ "type": {
45205
+ "type": "string",
45206
+ "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.",
45207
+ "nullable": true,
45208
+ "example": "Epic"
45173
45209
  }
45174
45210
  }
45175
45211
  },
@@ -92735,7 +92771,7 @@
92735
92771
  },
92736
92772
  "dependabot_secrets": {
92737
92773
  "type": "string",
92738
- "description": "The leve of permission to grant the access token to manage Dependabot secrets.",
92774
+ "description": "The level of permission to grant the access token to manage Dependabot secrets.",
92739
92775
  "enum": [
92740
92776
  "read",
92741
92777
  "write"
@@ -94048,6 +94084,7 @@
94048
94084
  "id": {
94049
94085
  "description": "Unique identifier of the webhook delivery.",
94050
94086
  "type": "integer",
94087
+ "format": "int64",
94051
94088
  "example": 42
94052
94089
  },
94053
94090
  "guid": {
@@ -94095,12 +94132,14 @@
94095
94132
  "installation_id": {
94096
94133
  "description": "The id of the GitHub App installation associated with this event.",
94097
94134
  "type": "integer",
94135
+ "format": "int64",
94098
94136
  "example": 123,
94099
94137
  "nullable": true
94100
94138
  },
94101
94139
  "repository_id": {
94102
94140
  "description": "The id of the repository associated with this event.",
94103
94141
  "type": "integer",
94142
+ "format": "int64",
94104
94143
  "example": 123,
94105
94144
  "nullable": true
94106
94145
  },
@@ -95875,12 +95914,12 @@
95875
95914
  "type": "object",
95876
95915
  "properties": {
95877
95916
  "id": {
95878
- "description": "The id of the runner.",
95917
+ "description": "The ID of the runner.",
95879
95918
  "type": "integer",
95880
95919
  "example": 5
95881
95920
  },
95882
95921
  "runner_group_id": {
95883
- "description": "The id of the runner group.",
95922
+ "description": "The ID of the runner group.",
95884
95923
  "type": "integer",
95885
95924
  "example": 1
95886
95925
  },
@@ -97539,6 +97578,66 @@
97539
97578
  ],
97540
97579
  "nullable": true
97541
97580
  },
97581
+ "issue-type": {
97582
+ "title": "Issue Type",
97583
+ "description": "The type of issue.",
97584
+ "type": "object",
97585
+ "nullable": true,
97586
+ "properties": {
97587
+ "id": {
97588
+ "type": "integer",
97589
+ "description": "The unique identifier of the issue type."
97590
+ },
97591
+ "node_id": {
97592
+ "type": "string",
97593
+ "description": "The node identifier of the issue type."
97594
+ },
97595
+ "name": {
97596
+ "type": "string",
97597
+ "description": "The name of the issue type."
97598
+ },
97599
+ "description": {
97600
+ "type": "string",
97601
+ "description": "The description of the issue type.",
97602
+ "nullable": true
97603
+ },
97604
+ "color": {
97605
+ "type": "string",
97606
+ "description": "The color of the issue type.",
97607
+ "enum": [
97608
+ "gray",
97609
+ "blue",
97610
+ "green",
97611
+ "yellow",
97612
+ "orange",
97613
+ "red",
97614
+ "pink",
97615
+ "purple"
97616
+ ],
97617
+ "nullable": true
97618
+ },
97619
+ "created_at": {
97620
+ "type": "string",
97621
+ "description": "The time the issue type created.",
97622
+ "format": "date-time"
97623
+ },
97624
+ "updated_at": {
97625
+ "type": "string",
97626
+ "description": "The time the issue type last updated.",
97627
+ "format": "date-time"
97628
+ },
97629
+ "is_enabled": {
97630
+ "type": "boolean",
97631
+ "description": "The enabled state of the issue type."
97632
+ }
97633
+ },
97634
+ "required": [
97635
+ "id",
97636
+ "node_id",
97637
+ "name",
97638
+ "description"
97639
+ ]
97640
+ },
97542
97641
  "nullable-integration": {
97543
97642
  "title": "GitHub app",
97544
97643
  "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
@@ -97961,6 +98060,9 @@
97961
98060
  "type": "string",
97962
98061
  "format": "uri"
97963
98062
  },
98063
+ "type": {
98064
+ "$ref": "#/components/schemas/issue-type"
98065
+ },
97964
98066
  "repository": {
97965
98067
  "$ref": "#/components/schemas/repository"
97966
98068
  },
@@ -114485,6 +114587,9 @@
114485
114587
  "type": "string",
114486
114588
  "format": "uri"
114487
114589
  },
114590
+ "type": {
114591
+ "$ref": "#/components/schemas/issue-type"
114592
+ },
114488
114593
  "repository": {
114489
114594
  "$ref": "#/components/schemas/repository"
114490
114595
  },
@@ -120052,6 +120157,9 @@
120052
120157
  "type": "string",
120053
120158
  "format": "uri"
120054
120159
  },
120160
+ "type": {
120161
+ "$ref": "#/components/schemas/issue-type"
120162
+ },
120055
120163
  "performed_via_github_app": {
120056
120164
  "$ref": "#/components/schemas/nullable-integration"
120057
120165
  },
@@ -126093,6 +126201,9 @@
126093
126201
  "description": "Title of the issue",
126094
126202
  "type": "string"
126095
126203
  },
126204
+ "type": {
126205
+ "$ref": "#/components/schemas/issue-type"
126206
+ },
126096
126207
  "updated_at": {
126097
126208
  "type": "string",
126098
126209
  "format": "date-time"
@@ -127484,6 +127595,9 @@
127484
127595
  "description": "Title of the issue",
127485
127596
  "type": "string"
127486
127597
  },
127598
+ "type": {
127599
+ "$ref": "#/components/schemas/issue-type"
127600
+ },
127487
127601
  "updated_at": {
127488
127602
  "type": "string",
127489
127603
  "format": "date-time"
@@ -151035,6 +151149,9 @@
151035
151149
  "description": "Title of the issue",
151036
151150
  "type": "string"
151037
151151
  },
151152
+ "type": {
151153
+ "$ref": "#/components/schemas/issue-type"
151154
+ },
151038
151155
  "updated_at": {
151039
151156
  "type": "string",
151040
151157
  "format": "date-time"
@@ -152617,6 +152734,9 @@
152617
152734
  "description": "Title of the issue",
152618
152735
  "type": "string"
152619
152736
  },
152737
+ "type": {
152738
+ "$ref": "#/components/schemas/issue-type"
152739
+ },
152620
152740
  "updated_at": {
152621
152741
  "type": "string",
152622
152742
  "format": "date-time"
@@ -154208,6 +154328,9 @@
154208
154328
  "description": "Title of the issue",
154209
154329
  "type": "string"
154210
154330
  },
154331
+ "type": {
154332
+ "$ref": "#/components/schemas/issue-type"
154333
+ },
154211
154334
  "updated_at": {
154212
154335
  "type": "string",
154213
154336
  "format": "date-time"
@@ -155833,6 +155956,9 @@
155833
155956
  "description": "Title of the issue",
155834
155957
  "type": "string"
155835
155958
  },
155959
+ "type": {
155960
+ "$ref": "#/components/schemas/issue-type"
155961
+ },
155836
155962
  "updated_at": {
155837
155963
  "type": "string",
155838
155964
  "format": "date-time"
@@ -157274,6 +157400,9 @@
157274
157400
  "description": "Title of the issue",
157275
157401
  "type": "string"
157276
157402
  },
157403
+ "type": {
157404
+ "$ref": "#/components/schemas/issue-type"
157405
+ },
157277
157406
  "updated_at": {
157278
157407
  "type": "string",
157279
157408
  "format": "date-time"
@@ -158536,6 +158665,9 @@
158536
158665
  "description": "Title of the issue",
158537
158666
  "type": "string"
158538
158667
  },
158668
+ "type": {
158669
+ "$ref": "#/components/schemas/issue-type"
158670
+ },
158539
158671
  "updated_at": {
158540
158672
  "type": "string",
158541
158673
  "format": "date-time"
@@ -159787,6 +159919,9 @@
159787
159919
  "type": "string",
159788
159920
  "format": "uri"
159789
159921
  },
159922
+ "type": {
159923
+ "$ref": "#/components/schemas/issue-type"
159924
+ },
159790
159925
  "title": {
159791
159926
  "description": "Title of the issue",
159792
159927
  "type": "string"
@@ -161035,6 +161170,9 @@
161035
161170
  "type": "string",
161036
161171
  "format": "uri"
161037
161172
  },
161173
+ "type": {
161174
+ "$ref": "#/components/schemas/issue-type"
161175
+ },
161038
161176
  "title": {
161039
161177
  "description": "Title of the issue",
161040
161178
  "type": "string"
@@ -162309,6 +162447,9 @@
162309
162447
  "type": "string",
162310
162448
  "format": "uri"
162311
162449
  },
162450
+ "type": {
162451
+ "$ref": "#/components/schemas/issue-type"
162452
+ },
162312
162453
  "title": {
162313
162454
  "description": "Title of the issue",
162314
162455
  "type": "string"
@@ -163551,6 +163692,9 @@
163551
163692
  "description": "Title of the issue",
163552
163693
  "type": "string"
163553
163694
  },
163695
+ "type": {
163696
+ "$ref": "#/components/schemas/issue-type"
163697
+ },
163554
163698
  "updated_at": {
163555
163699
  "type": "string",
163556
163700
  "format": "date-time"
@@ -166594,6 +166738,9 @@
166594
166738
  "description": "Title of the issue",
166595
166739
  "type": "string"
166596
166740
  },
166741
+ "type": {
166742
+ "$ref": "#/components/schemas/issue-type"
166743
+ },
166597
166744
  "updated_at": {
166598
166745
  "type": "string",
166599
166746
  "format": "date-time"
@@ -168000,6 +168147,9 @@
168000
168147
  "type": "string"
168001
168148
  }
168002
168149
  }
168150
+ },
168151
+ "type": {
168152
+ "$ref": "#/components/schemas/issue-type"
168003
168153
  }
168004
168154
  }
168005
168155
  },
@@ -169110,6 +169260,9 @@
169110
169260
  "description": "Title of the issue",
169111
169261
  "type": "string"
169112
169262
  },
169263
+ "type": {
169264
+ "$ref": "#/components/schemas/issue-type"
169265
+ },
169113
169266
  "updated_at": {
169114
169267
  "type": "string",
169115
169268
  "format": "date-time"
@@ -171075,6 +171228,9 @@
171075
171228
  "description": "Title of the issue",
171076
171229
  "type": "string"
171077
171230
  },
171231
+ "type": {
171232
+ "$ref": "#/components/schemas/issue-type"
171233
+ },
171078
171234
  "updated_at": {
171079
171235
  "type": "string",
171080
171236
  "format": "date-time"
@@ -281603,6 +281759,20 @@
281603
281759
  "format": "date-time"
281604
281760
  }
281605
281761
  },
281762
+ "personal-access-token-token-id": {
281763
+ "name": "token_id",
281764
+ "description": "The ID of the token",
281765
+ "in": "query",
281766
+ "required": false,
281767
+ "schema": {
281768
+ "type": "array",
281769
+ "maxItems": 50,
281770
+ "items": {
281771
+ "type": "string"
281772
+ },
281773
+ "example": "token_id[]=1,token_id[]=2"
281774
+ }
281775
+ },
281606
281776
  "fine-grained-personal-access-token-id": {
281607
281777
  "name": "pat_id",
281608
281778
  "description": "The unique identifier of the fine-grained personal access token.",