Skip to content

Commit 409be6d

Browse files
WyriHaximusgithub-actions[bot]
authored andcommitted
[GitHub] Update to 1.1.4-258d33610c11c1d10d29617d894e1ce8 from 1.1.4-1f428455b4cea06755dbb12f469fc171
Detected Schema changes: ``` ├─┬Paths │ ├─┬/networks/{owner}/{repo}/events │ │ └─┬GET │ │ └──[➖] description (3372:20) │ ├─┬/users/{username}/received_events │ │ └─┬GET │ │ └──[🔀] description (46830:20) │ ├─┬/events │ │ └─┬GET │ │ └──[🔀] description (1680:20) │ ├─┬/users/{username}/received_events/public │ │ └─┬GET │ │ └──[➖] description (46878:20) │ ├─┬/users/{username}/events/public │ │ └─┬GET │ │ └──[➖] description (46128:20) │ ├─┬/users/{username}/events │ │ └─┬GET │ │ └──[🔀] description (46053:20) │ ├─┬/users/{username}/events/orgs/{org} │ │ └─┬GET │ │ └──[🔀] description (46085:20) │ └─┬/orgs/{org}/events │ └─┬GET │ └──[➖] description (8426:20) └─┬Components └─┬pull-request-review └─┬id └──[➖] format (86490:19)❌ ``` | Document Element | Total Changes | Breaking Changes | |------------------|---------------|------------------| | paths | 8 | 0 | | components | 1 | 1 | Date: 08/02/24 | Commit: New: etc/specs/GitHub/previous.spec.yaml, Original: etc/specs/GitHub/current.spec.yaml - ❌ **BREAKING Changes**: _1_ out of _9_ - **Modifications**: _4_ - **Removals**: _5_ - **Breaking Removals**: _1_ ERROR: breaking changes discovered
1 parent 042b3ae commit 409be6d

File tree

6 files changed

+86
-67
lines changed

6 files changed

+86
-67
lines changed

clients/GitHub/etc/openapi-client-generator.state

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"specHash": "1f428455b4cea06755dbb12f469fc171",
2+
"specHash": "258d33610c11c1d10d29617d894e1ce8",
33
"generatedFiles": {
44
"files": [
55
{
@@ -440,7 +440,7 @@
440440
},
441441
{
442442
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/CodeScanningOrganizationAlertItems.php",
443-
"hash": "2f8e2e63012bcce47f7b26ec709174c6"
443+
"hash": "3710c419a0a4d200bcd85f0227a47fbc"
444444
},
445445
{
446446
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/CodespaceMachine.php",
@@ -844,11 +844,11 @@
844844
},
845845
{
846846
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/CodeScanningAlertRuleSummary.php",
847-
"hash": "d31d1a0df17cad29106204b4749d0550"
847+
"hash": "3d313d12408b39ac2145d20fa08ad45c"
848848
},
849849
{
850850
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/CodeScanningAlertItems.php",
851-
"hash": "6890258dc8a7950fc2dcad38a2f554c6"
851+
"hash": "25e47067404179c058125d6893424f86"
852852
},
853853
{
854854
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/CodeScanningAlert.php",
@@ -1308,7 +1308,7 @@
13081308
},
13091309
{
13101310
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/PullRequestReview.php",
1311-
"hash": "34ef1d29ef808d513a7bf73066da474d"
1311+
"hash": "d705f5ad9a1b1feab6c273ba6ee38687"
13121312
},
13131313
{
13141314
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/ReviewComment.php",
@@ -5612,7 +5612,7 @@
56125612
},
56135613
{
56145614
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Repos.php",
5615-
"hash": "8424548ebe6553d096fbe836b3a9382f"
5615+
"hash": "16d5e12cbe10bf1544d358fb6ce2264c"
56165616
},
56175617
{
56185618
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Billing.php",
@@ -29824,7 +29824,7 @@
2982429824
},
2982529825
{
2982629826
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/CodeSecurity.php",
29827-
"hash": "0f0cad39f86e6ac4799e47f3d4c2fa07"
29827+
"hash": "9a02ccb9703c1159bd4b88452a72da78"
2982829828
},
2982929829
{
2983029830
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Hydrator\/Operation\/Orgs\/Org\/CodeSecurity\/Configurations.php",

clients/GitHub/src/Schema/CodeScanningAlertItems.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -292,16 +292,6 @@
292292
"type": "string",
293293
"description": "The name of the rule used to detect the alert."
294294
},
295-
"tags": {
296-
"type": [
297-
"array",
298-
"null"
299-
],
300-
"items": {
301-
"type": "string"
302-
},
303-
"description": "A set of tags applicable for the rule."
304-
},
305295
"severity": {
306296
"enum": [
307297
"none",
@@ -333,6 +323,16 @@
333323
"description": {
334324
"type": "string",
335325
"description": "A short description of the rule used to detect the alert."
326+
},
327+
"tags": {
328+
"type": [
329+
"array",
330+
"null"
331+
],
332+
"items": {
333+
"type": "string"
334+
},
335+
"description": "A set of tags applicable for the rule."
336336
}
337337
}
338338
},
@@ -484,10 +484,10 @@
484484
"rule": {
485485
"id": "generated",
486486
"name": "generated",
487-
"tags": null,
488487
"severity": "error",
489488
"security_severity_level": "low",
490-
"description": "generated"
489+
"description": "generated",
490+
"tags": null
491491
},
492492
"tool": {
493493
"name": "generated",

clients/GitHub/src/Schema/CodeScanningAlertRuleSummary.php

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,6 @@
2222
"type": "string",
2323
"description": "The name of the rule used to detect the alert."
2424
},
25-
"tags": {
26-
"type": [
27-
"array",
28-
"null"
29-
],
30-
"items": {
31-
"type": "string"
32-
},
33-
"description": "A set of tags applicable for the rule."
34-
},
3525
"severity": {
3626
"enum": [
3727
"none",
@@ -63,6 +53,16 @@
6353
"description": {
6454
"type": "string",
6555
"description": "A short description of the rule used to detect the alert."
56+
},
57+
"tags": {
58+
"type": [
59+
"array",
60+
"null"
61+
],
62+
"items": {
63+
"type": "string"
64+
},
65+
"description": "A set of tags applicable for the rule."
6666
}
6767
}
6868
}';
@@ -71,22 +71,22 @@
7171
public const SCHEMA_EXAMPLE_DATA = '{
7272
"id": "generated",
7373
"name": "generated",
74-
"tags": null,
7574
"severity": "error",
7675
"security_severity_level": "low",
77-
"description": "generated"
76+
"description": "generated",
77+
"tags": null
7878
}';
7979

8080
/**
8181
* id: A unique identifier for the rule used to detect the alert.
8282
* name: The name of the rule used to detect the alert.
83-
* tags: A set of tags applicable for the rule.
8483
* severity: The severity of the alert.
8584
* securitySeverityLevel: The security severity of the alert.
8685
* description: A short description of the rule used to detect the alert.
86+
* tags: A set of tags applicable for the rule.
8787
*/
88-
public function __construct(public string|null $id, public string|null $name, public array|null $tags, public string|null $severity, #[MapFrom('security_severity_level')]
89-
public string|null $securitySeverityLevel, public string|null $description,)
88+
public function __construct(public string|null $id, public string|null $name, public string|null $severity, #[MapFrom('security_severity_level')]
89+
public string|null $securitySeverityLevel, public string|null $description, public array|null $tags,)
9090
{
9191
}
9292
}

clients/GitHub/src/Schema/CodeScanningOrganizationAlertItems.php

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -293,16 +293,6 @@
293293
"type": "string",
294294
"description": "The name of the rule used to detect the alert."
295295
},
296-
"tags": {
297-
"type": [
298-
"array",
299-
"null"
300-
],
301-
"items": {
302-
"type": "string"
303-
},
304-
"description": "A set of tags applicable for the rule."
305-
},
306296
"severity": {
307297
"enum": [
308298
"none",
@@ -334,6 +324,16 @@
334324
"description": {
335325
"type": "string",
336326
"description": "A short description of the rule used to detect the alert."
327+
},
328+
"tags": {
329+
"type": [
330+
"array",
331+
"null"
332+
],
333+
"items": {
334+
"type": "string"
335+
},
336+
"description": "A set of tags applicable for the rule."
337337
}
338338
}
339339
},
@@ -1030,10 +1030,10 @@
10301030
"rule": {
10311031
"id": "generated",
10321032
"name": "generated",
1033-
"tags": null,
10341033
"severity": "error",
10351034
"security_severity_level": "low",
1036-
"description": "generated"
1035+
"description": "generated",
1036+
"tags": null
10371037
},
10381038
"tool": {
10391039
"name": "generated",

clients/GitHub/src/Schema/PullRequestReview.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"id": {
2929
"type": "integer",
3030
"description": "Unique identifier of the review",
31+
"format": "int64",
3132
"examples": [
3233
42
3334
]

etc/specs/GitHub/current.spec.yaml

Lines changed: 39 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1677,9 +1677,9 @@ paths:
16771677
"/events":
16781678
get:
16791679
summary: List public events
1680-
description: We delay the public events feed by five minutes, which means the
1681-
most recent event returned by the public events API actually occurred at least
1682-
five minutes ago.
1680+
description: |-
1681+
> [!NOTE]
1682+
> 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.
16831683
tags:
16841684
- activity
16851685
operationId: activity/list-public-events
@@ -3369,7 +3369,9 @@ paths:
33693369
"/networks/{owner}/{repo}/events":
33703370
get:
33713371
summary: List public events for a network of repositories
3372-
description: ''
3372+
description: |-
3373+
> [!NOTE]
3374+
> 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.
33733375
tags:
33743376
- activity
33753377
operationId: activity/list-public-events-for-repo-network
@@ -8421,7 +8423,9 @@ paths:
84218423
"/orgs/{org}/events":
84228424
get:
84238425
summary: List public organization events
8424-
description: ''
8426+
description: |-
8427+
> [!NOTE]
8428+
> 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.
84258429
tags:
84268430
- activity
84278431
operationId: activity/list-public-org-events
@@ -46050,8 +46054,11 @@ paths:
4605046054
"/users/{username}/events":
4605146055
get:
4605246056
summary: List events for the authenticated user
46053-
description: If you are authenticated as the given user, you will see your private
46054-
events. Otherwise, you'll only see public events.
46057+
description: |-
46058+
If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
46059+
46060+
> [!NOTE]
46061+
> 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.
4605546062
tags:
4605646063
- activity
4605746064
operationId: activity/list-events-for-authenticated-user
@@ -46082,8 +46089,11 @@ paths:
4608246089
"/users/{username}/events/orgs/{org}":
4608346090
get:
4608446091
summary: List organization events for the authenticated user
46085-
description: This is the user's organization dashboard. You must be authenticated
46086-
as the user to view this.
46092+
description: |-
46093+
This is the user's organization dashboard. You must be authenticated as the user to view this.
46094+
46095+
> [!NOTE]
46096+
> 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.
4608746097
tags:
4608846098
- activity
4608946099
operationId: activity/list-org-events-for-authenticated-user
@@ -46115,7 +46125,9 @@ paths:
4611546125
"/users/{username}/events/public":
4611646126
get:
4611746127
summary: List public events for a user
46118-
description: ''
46128+
description: |-
46129+
> [!NOTE]
46130+
> 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.
4611946131
tags:
4612046132
- activity
4612146133
operationId: activity/list-public-events-for-user
@@ -46827,9 +46839,12 @@ paths:
4682746839
"/users/{username}/received_events":
4682846840
get:
4682946841
summary: List events received by the authenticated user
46830-
description: These are events that you've received by watching repositories
46831-
and following users. If you are authenticated as the given user, you will
46832-
see private events. Otherwise, you'll only see public events.
46842+
description: |-
46843+
These are events that you've received by watching repositories and following users. If you are authenticated as the
46844+
given user, you will see private events. Otherwise, you'll only see public events.
46845+
46846+
> [!NOTE]
46847+
> 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.
4683346848
tags:
4683446849
- activity
4683546850
operationId: activity/list-received-events-for-user
@@ -46860,7 +46875,9 @@ paths:
4686046875
"/users/{username}/received_events/public":
4686146876
get:
4686246877
summary: List public events received by a user
46863-
description: ''
46878+
description: |-
46879+
> [!NOTE]
46880+
> 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.
4686446881
tags:
4686546882
- activity
4686646883
operationId: activity/list-received-public-events-for-user
@@ -70836,13 +70853,6 @@ components:
7083670853
name:
7083770854
type: string
7083870855
description: The name of the rule used to detect the alert.
70839-
tags:
70840-
type:
70841-
- array
70842-
- 'null'
70843-
description: A set of tags applicable for the rule.
70844-
items:
70845-
type: string
7084670856
severity:
7084770857
type:
7084870858
- string
@@ -70868,6 +70878,13 @@ components:
7086870878
description:
7086970879
type: string
7087070880
description: A short description of the rule used to detect the alert.
70881+
tags:
70882+
type:
70883+
- array
70884+
- 'null'
70885+
description: A set of tags applicable for the rule.
70886+
items:
70887+
type: string
7087170888
code-scanning-analysis-tool-version:
7087270889
type:
7087370890
- string
@@ -86470,6 +86487,7 @@ components:
8647086487
id:
8647186488
description: Unique identifier of the review
8647286489
type: integer
86490+
format: int64
8647386491
examples:
8647486492
- 42
8647586493
node_id:

0 commit comments

Comments
 (0)