Skip to content

Commit e478fc2

Browse files
authored
[GitHubAE] Update to 1.1.4-f264cd8fc305b9584ace80883c429a95 from 1.1.4-685363466de14cc34165c665b088a065
Detected Schema changes: ├─┬Paths │ ├─┬/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances │ │ └─┬GET │ │ └──Parameters │ ├─┬/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo} │ │ └─┬GET │ │ └──[M] description (9881:20) │ ├─┬/repos/{owner}/{repo}/code-scanning/sarifs │ │ └─┬POST │ │ └─┬Requestbody │ │ └─┬application/json │ │ └─┬Schema │ │ ├──[-] additionalProperties (16690:37)❌ │ │ └─┬ref │ │ └──[M] $ref (51847:13)❌ │ ├─┬/repos/{owner}/{repo}/code-scanning/alerts │ │ └─┬GET │ │ └──Parameters │ └─┬/repos/{owner}/{repo}/code-scanning/analyses │ └─┬GET │ └──Parameters ├─┬ping │ └──POST └─┬Components ├──[-] schemas (56946:7)❌ └─┬code-scanning-ref └──[M] description (51848:20) Date: 11/15/23 | Commit: New: etc/specs/GitHubAE/previous.spec.yaml, Original: etc/specs/GitHubAE/current.spec.yaml Document Element | Total Changes | Breaking Changes paths | 3 | 2 components | 2 | 1 ❌ 3 Breaking changes out of 5 INFO: Modifications: 3 INFO: Removals: 2 INFO: Breaking Removals: 2 INFO: Breaking Modifications: 1 ERROR: breaking changes discovered
1 parent cd2be02 commit e478fc2

9 files changed

+83
-49
lines changed

etc/openapi-client-generator.state

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"specHash": "685363466de14cc34165c665b088a065",
2+
"specHash": "f264cd8fc305b9584ace80883c429a95",
33
"generatedFiles": {
44
"files": [
55
{
@@ -440,7 +440,7 @@
440440
},
441441
{
442442
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningRef.php",
443-
"hash": "2e2a109947c432fe7cbefb3149e70f56"
443+
"hash": "ea3ba33230c701c1e5120cf0576cc410"
444444
},
445445
{
446446
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAnalysisAnalysisKey.php",
@@ -464,11 +464,11 @@
464464
},
465465
{
466466
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAlertInstance.php",
467-
"hash": "fdb9e8f37e97696b4006deeb62d4692f"
467+
"hash": "29ef7191f028dc46f1ae41149b5783f8"
468468
},
469469
{
470470
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningOrganizationAlertItems.php",
471-
"hash": "e138d0838be6f316db6cf04a6e2e209a"
471+
"hash": "78a9834d04c1617c0c10f6bed0a0f036"
472472
},
473473
{
474474
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/ExternalGroup.php",
@@ -692,11 +692,11 @@
692692
},
693693
{
694694
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAlertItems.php",
695-
"hash": "10c32cec3e870752bd63c6deef7517fa"
695+
"hash": "80279a3963e8841dea15abfb9b0afaab"
696696
},
697697
{
698698
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAlert.php",
699-
"hash": "15a988462c51e2e841bac4ed1dbeb5e2"
699+
"hash": "df5e7fd599bc8f6805d357d6b908f74a"
700700
},
701701
{
702702
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAlertSetState.php",
@@ -724,7 +724,7 @@
724724
},
725725
{
726726
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAnalysis.php",
727-
"hash": "4ae36dce535cc9f048a546d9669c6efa"
727+
"hash": "7f0210141ea14018b07353a1bf3c6937"
728728
},
729729
{
730730
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningAnalysisDeletion.php",
@@ -4380,7 +4380,7 @@
43804380
},
43814381
{
43824382
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanning\/UploadSarif\/Request\/ApplicationJson.php",
4383-
"hash": "48fd6e67d758dad6b0c20995327dad31"
4383+
"hash": "632219b855e4c893441eabaa0b842937"
43844384
},
43854385
{
43864386
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/Repos\/AddCollaborator\/Request\/ApplicationJson.php",
@@ -4844,107 +4844,107 @@
48444844
},
48454845
{
48464846
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Meta.php",
4847-
"hash": "92c7fabcee0d20ede443a0cda8271161"
4847+
"hash": "2dd006cd2d18855634f50a8380dab26f"
48484848
},
48494849
{
48504850
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/EnterpriseAdmin.php",
4851-
"hash": "6fded48f474f856a82c3bfaea3962133"
4851+
"hash": "39cede2df144c50eb9e8a399160d7c1b"
48524852
},
48534853
{
48544854
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Apps.php",
4855-
"hash": "f0fe091b381b37e6ec9c444b18614eae"
4855+
"hash": "6ce6dc25f82af02b2cf9f70237e7c1aa"
48564856
},
48574857
{
48584858
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/CodesOfConduct.php",
4859-
"hash": "af889402873ba23d01238ac3c6f0d49b"
4859+
"hash": "cbd23a341169bc297d576f1a511489bd"
48604860
},
48614861
{
48624862
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Emojis.php",
4863-
"hash": "65e1ae527081db96187535785b9c95cf"
4863+
"hash": "a9c95e8e2f9865e58e262935aacd339d"
48644864
},
48654865
{
48664866
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/SecretScanning.php",
4867-
"hash": "94f264a07b7d39f874565366ef1066fe"
4867+
"hash": "e0a069c8c36d053fba64c321ffb9555f"
48684868
},
48694869
{
48704870
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Activity.php",
4871-
"hash": "52e9d67ffdae1a57d8bdcf259691fa8c"
4871+
"hash": "7d03e77a821dd96fa8b36759be922c0f"
48724872
},
48734873
{
48744874
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Gists.php",
4875-
"hash": "87c9617b11d06d9488cedb07491ae3ca"
4875+
"hash": "1ca991fbe1b3f7ab133b287d31a8a744"
48764876
},
48774877
{
48784878
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Gitignore.php",
4879-
"hash": "2eb8c51fb1396ef2d68e0949dd32b16e"
4879+
"hash": "b512e8292b315246e499e51952b23057"
48804880
},
48814881
{
48824882
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Issues.php",
4883-
"hash": "42b9272807bfa9a5bce3d207f33b10f8"
4883+
"hash": "3985bab680fabf44503ad6be3f7f5f52"
48844884
},
48854885
{
48864886
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Licenses.php",
4887-
"hash": "a8a47b00248092d5ad4ec44b8cfbcd17"
4887+
"hash": "6fee1cec1d963b280796d047fca624ee"
48884888
},
48894889
{
48904890
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Markdown.php",
4891-
"hash": "52e92defa0051eba1a99e7c9502987eb"
4891+
"hash": "67ee93e2c8ac266a484f223b2d1a3901"
48924892
},
48934893
{
48944894
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Orgs.php",
4895-
"hash": "786e08763db23214deeb701df043736d"
4895+
"hash": "9fd0060eb02bbfe20be1b7a56dd90c48"
48964896
},
48974897
{
48984898
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Actions.php",
4899-
"hash": "83b4926426a1423cfa90a067cdf5c86d"
4899+
"hash": "5e02bbc492898fe82f06b40a523413b8"
49004900
},
49014901
{
49024902
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/CodeScanning.php",
4903-
"hash": "95ad7b12627b2ca37e4bd7a1f020665f"
4903+
"hash": "b8c6914f0d80802faa46ba41ae5d7995"
49044904
},
49054905
{
49064906
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Teams.php",
4907-
"hash": "d28afb3e450d54ca35dfa6c9b3fb1bab"
4907+
"hash": "df084dc2d44e1516a45b7877558553d4"
49084908
},
49094909
{
49104910
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Migrations.php",
4911-
"hash": "a067ee9091af75bfffdd65c57fffe6af"
4911+
"hash": "a891703ec0988c9e7eeca3479fb33990"
49124912
},
49134913
{
49144914
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Projects.php",
4915-
"hash": "ef3652ca1d7e67e6032e159ab9a66a43"
4915+
"hash": "2d82cb7abfe9d5ea4a24a3a7f2886775"
49164916
},
49174917
{
49184918
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Repos.php",
4919-
"hash": "d8b1aa6b107729115669d8a680658a9c"
4919+
"hash": "2f80e9b8cc8c01a5e720ed6a02704702"
49204920
},
49214921
{
49224922
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Reactions.php",
4923-
"hash": "2500dde62df8a0164eeb5f8b06af1d5b"
4923+
"hash": "464ec6f02194f9db909fe1e01314017a"
49244924
},
49254925
{
49264926
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/RateLimit.php",
4927-
"hash": "2de04aa329befb4692c6a029291ec63d"
4927+
"hash": "50814f840455feb7c3b417d88fa859c1"
49284928
},
49294929
{
49304930
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Checks.php",
4931-
"hash": "1af10ca5fe5b1457ca15b7bf86f5b9cc"
4931+
"hash": "21893139c26dc1808f86dd2886a35a8d"
49324932
},
49334933
{
49344934
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Git.php",
4935-
"hash": "b862ff1548703e2c311272b81af9eab2"
4935+
"hash": "96f09cc6566ed62465718fcde87aa4fd"
49364936
},
49374937
{
49384938
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Pulls.php",
4939-
"hash": "db669548dfe3021594100230d0fb1414"
4939+
"hash": "cb40b10f153a5ed8d20eb336685ef533"
49404940
},
49414941
{
49424942
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Search.php",
4943-
"hash": "1b4a67b225f2d9e1605bb453fc99f848"
4943+
"hash": "231a63de45d9bac03ddfd8b92a041121"
49444944
},
49454945
{
49464946
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operation\/Users.php",
4947-
"hash": "a15d67dd0a152d7cc617a434417364d4"
4947+
"hash": "0fa3b78791c83a93275e406285e1f001"
49484948
},
49494949
{
49504950
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Operations.php",
@@ -23969,6 +23969,10 @@
2396923969
{
2397023970
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Internal\/Hydrator\/WebHook\/WorkflowRun.php",
2397123971
"hash": "bd506f1bad7298bb0312dbc05ea67a94"
23972+
},
23973+
{
23974+
"name": ".\/clients\/GitHubAE\/etc\/..\/\/src\/\/Schema\/CodeScanningRefFull.php",
23975+
"hash": "ef45d0e89ff1a5dd91e3a9b76ddadd85"
2397223976
}
2397323977
]
2397423978
},

src/Schema/CodeScanning/UploadSarif/Request/ApplicationJson.php

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,12 @@
2424
"description": "The SHA of the commit to which the analysis you are uploading relates."
2525
},
2626
"ref": {
27+
"pattern": "^refs\\/(heads|pull)\\/.*$",
2728
"type": "string",
28-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
29+
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`.",
30+
"examples": [
31+
"refs\\/heads\\/main"
32+
]
2933
},
3034
"sarif": {
3135
"type": "string",
@@ -48,13 +52,14 @@
4852
"type": "string",
4953
"description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \\"API\\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET \\/repos\\/{owner}\\/{repo}\\/code-scanning\\/alerts`."
5054
}
51-
}
55+
},
56+
"additionalProperties": false
5257
}';
5358
public const SCHEMA_TITLE = '';
5459
public const SCHEMA_DESCRIPTION = '';
5560
public const SCHEMA_EXAMPLE_DATA = '{
5661
"commit_sha": "DDDDDDDDDDDDDD",
57-
"ref": "generated",
62+
"ref": "refs\\/heads\\/main",
5863
"sarif": "generated",
5964
"checkout_uri": "file:\\/\\/\\/github\\/workspace\\/",
6065
"started_at": "1970-01-01T00:00:00+00:00",

src/Schema/CodeScanningAlert.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@
358358
"properties": {
359359
"ref": {
360360
"type": "string",
361-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
361+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
362362
},
363363
"analysis_key": {
364364
"type": "string",

src/Schema/CodeScanningAlertInstance.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"properties": {
1515
"ref": {
1616
"type": "string",
17-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
17+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
1818
},
1919
"analysis_key": {
2020
"type": "string",
@@ -119,8 +119,8 @@
119119
}';
120120

121121
/**
122-
* ref: The full Git reference, formatted as `refs/heads/<branch name>`,
123-
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`.
122+
* ref: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
123+
`refs/heads/<branch name>` or simply `<branch name>`.
124124
* analysisKey: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
125125
* environment: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
126126
* category: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.

src/Schema/CodeScanningAlertItems.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@
316316
"properties": {
317317
"ref": {
318318
"type": "string",
319-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
319+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
320320
},
321321
"analysis_key": {
322322
"type": "string",

src/Schema/CodeScanningAnalysis.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
"properties": {
3131
"ref": {
3232
"type": "string",
33-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
33+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
3434
},
3535
"commit_sha": {
3636
"maxLength": 40,
@@ -148,8 +148,8 @@
148148
}';
149149

150150
/**
151-
* ref: The full Git reference, formatted as `refs/heads/<branch name>`,
152-
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`.
151+
* ref: The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
152+
`refs/heads/<branch name>` or simply `<branch name>`.
153153
* commitSha: The SHA of the commit to which the analysis you are uploading relates.
154154
* analysisKey: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
155155
* environment: Identifies the variable values associated with the environment in which this analysis was performed.

src/Schema/CodeScanningOrganizationAlertItems.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@
374374
"properties": {
375375
"ref": {
376376
"type": "string",
377-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
377+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
378378
},
379379
"analysis_key": {
380380
"type": "string",

src/Schema/CodeScanningRef.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,11 @@
88
{
99
public const SCHEMA_JSON = '{
1010
"type": "string",
11-
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`."
11+
"description": "The Git reference, formatted as `refs\\/pull\\/<number>\\/merge`, `refs\\/pull\\/<number>\\/head`,\\n`refs\\/heads\\/<branch name>` or simply `<branch name>`."
1212
}';
1313
public const SCHEMA_TITLE = '';
14-
public const SCHEMA_DESCRIPTION = 'The full Git reference, formatted as `refs/heads/<branch name>`,
15-
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`.';
14+
public const SCHEMA_DESCRIPTION = 'The Git reference, formatted as `refs/pull/<number>/merge`, `refs/pull/<number>/head`,
15+
`refs/heads/<branch name>` or simply `<branch name>`.';
1616
public const SCHEMA_EXAMPLE_DATA = '[]';
1717

1818
public function __construct()

src/Schema/CodeScanningRefFull.php

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace ApiClients\Client\GitHubAE\Schema;
6+
7+
final readonly class CodeScanningRefFull
8+
{
9+
public const SCHEMA_JSON = '{
10+
"pattern": "^refs\\/(heads|pull)\\/.*$",
11+
"type": "string",
12+
"description": "The full Git reference, formatted as `refs\\/heads\\/<branch name>`,\\n`refs\\/pull\\/<number>\\/merge`, or `refs\\/pull\\/<number>\\/head`.",
13+
"examples": [
14+
"refs\\/heads\\/main"
15+
]
16+
}';
17+
public const SCHEMA_TITLE = '';
18+
public const SCHEMA_DESCRIPTION = 'The full Git reference, formatted as `refs/heads/<branch name>`,
19+
`refs/pull/<number>/merge`, or `refs/pull/<number>/head`.';
20+
public const SCHEMA_EXAMPLE_DATA = '[]';
21+
22+
public function __construct()
23+
{
24+
}
25+
}

0 commit comments

Comments
 (0)