Skip to content

Commit f4355dc

Browse files
WyriHaximusgithub-actions[bot]
authored andcommitted
[GitHub] Update to 1.1.4-89579af3f1f5255ac2c758a7d1d6bcae from 1.1.4-3fc5da0b62540a45f2138abebf230a76
Detected Schema changes: starting work. Building original model for commit 9fcfbe SPEC: extracted 2 commits from history ``` ├─┬Paths │ └─┬/orgs/{org} │ ├─┬GET │ │ └──[🔀] description (3674:20) │ └─┬PATCH │ ├──[🔀] description (3711:20) │ └─┬Requestbody │ └─┬application/json │ └─┬Schema │ └─┬description │ └──[🔀] description (3754:32) └─┬Components ├──[➖] schemas (71803:7)❌ └──[➕] schemas (71780:7) ``` | Document Element | Total Changes | Breaking Changes | |------------------|---------------|------------------| | paths | 3 | 0 | | components | 2 | 1 | Date: 04/04/24 | Commit: New: etc/specs/GitHub/previous.spec.yaml, Original: etc/specs/GitHub/current.spec.yaml - ❌ **BREAKING Changes**: _5_ - **Modifications**: _3_ - **Removals**: _1_ - **Additions**: _1_ - **Breaking Removals**: _1_ ERROR: breaking changes discovered
1 parent 0765899 commit f4355dc

File tree

11 files changed

+122
-92
lines changed

11 files changed

+122
-92
lines changed

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

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"specHash": "3fc5da0b62540a45f2138abebf230a76",
2+
"specHash": "89579af3f1f5255ac2c758a7d1d6bcae",
33
"generatedFiles": {
44
"files": [
55
{
@@ -4656,7 +4656,7 @@
46564656
},
46574657
{
46584658
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Orgs\/Update\/Request\/ApplicationJson.php",
4659-
"hash": "71be84f13d27ff64f4925b23d91f9fca"
4659+
"hash": "c0422933c5557db861e6207a78b73542"
46604660
},
46614661
{
46624662
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/Operations\/Orgs\/Update\/Response\/ApplicationJson\/UnprocessableEntity.php",
@@ -5832,7 +5832,7 @@
58325832
},
58335833
{
58345834
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Pulls.php",
5835-
"hash": "c04a3852a873caba1c1cb5fa1d6809ce"
5835+
"hash": "60138d3a0e61f4cd49819b25927d75b3"
58365836
},
58375837
{
58385838
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/SecurityAdvisories.php",
@@ -22324,7 +22324,7 @@
2232422324
},
2232522325
{
2232622326
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Pulls\/Get.php",
22327-
"hash": "92889b523b752b34c4fc662a887df619"
22327+
"hash": "73ee842fc0292c59dc2200e2846b63bb"
2232822328
},
2232922329
{
2233022330
"name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Pulls\/GetTest.php",
@@ -26412,7 +26412,7 @@
2641226412
},
2641326413
{
2641426414
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Pulls.php",
26415-
"hash": "e632b6b1ae6e372daddc51110fac546a"
26415+
"hash": "5b1290dc5c87df2b913fae08560df1aa"
2641626416
},
2641726417
{
2641826418
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Billing.php",
@@ -26848,7 +26848,7 @@
2684826848
},
2684926849
{
2685026850
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Six.php",
26851-
"hash": "5d810b435cc9e1551a09c8f901cd27b0"
26851+
"hash": "147555754780b5408e6bdfb6561e2110"
2685226852
},
2685326853
{
2685426854
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Seven.php",
@@ -29676,11 +29676,11 @@
2967629676
},
2967729677
{
2967829678
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/PHPStan\/ClientCallReturnTypes.php",
29679-
"hash": "cfc185879effdc3851bfcb4839c949a6"
29679+
"hash": "9408a4fb50e75c12f4b05aa107e8928a"
2968029680
},
2968129681
{
2968229682
"name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Types\/ClientCallReturnTypes.php",
29683-
"hash": "dbbccace5b74e0da6ee51b823dd6a2bf"
29683+
"hash": "036db8bcfe296b31facfe15f66d870a5"
2968429684
},
2968529685
{
2968629686
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/..\/etc\/phpstan-extension.neon",
@@ -30710,13 +30710,13 @@
3071030710
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/AliasAbstract\/Tiet59467073\/Tiet58CE2E2F\/Tiet6601455F\/TietF3A22DF2.php",
3071130711
"hash": "fff74a4f9a26ba7d86f13900cca2f8b2"
3071230712
},
30713-
{
30714-
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRuleParamsCodeScanningThreshold.php",
30715-
"hash": "76ddecf8737d006bea293713ec257ae4"
30716-
},
3071730713
{
3071830714
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/SecretScanningLocationWikiCommit.php",
3071930715
"hash": "36b01c6e0bf80cafea1c17fab895c2af"
30716+
},
30717+
{
30718+
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Schema\/RepositoryRuleParamsCodeScanningTool.php",
30719+
"hash": "10135121514ba5aebc2b0fbec5fd0bec"
3072030720
}
3072130721
]
3072230722
},

clients/GitHub/src/Internal/Operator/Pulls/Get.php

+1
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ public function __construct(private Browser $browser, private AuthenticationInte
2525
{
2626
}
2727

28+
/** @return */
2829
public function call(string $owner, string $repo, int $pullNumber): PullRequest|WithoutBody
2930
{
3031
$operation = new \ApiClients\Client\GitHub\Internal\Operation\Pulls\Get($this->responseSchemaValidator, $this->hydrator, $owner, $repo, $pullNumber);

clients/GitHub/src/Internal/Router/Get/Pulls.php

+1
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ public function listReviewCommentsForRepo(array $params): iterable
138138
return $operator->call($arguments['owner'], $arguments['repo'], $arguments['sort'], $arguments['direction'], $arguments['since'], $arguments['per_page'], $arguments['page']);
139139
}
140140

141+
/** @return */
141142
public function get(array $params): PullRequest|WithoutBody
142143
{
143144
$arguments = [];

clients/GitHub/src/Internal/Router/Get/Six.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ public function __construct(private Routers $routers)
7373
{
7474
}
7575

76-
/** @return Observable<Schema\MarketplacePurchase>||Observable<Schema\RunnerApplication>|Observable<Schema\HookDeliveryItem>|Observable<Schema\Team>|Observable<Schema\MinimalRepository>|WithoutBody|Observable<Schema\SimpleUser>|Observable<Schema\TeamDiscussion>|Observable<Schema\OrganizationInvitation>|Observable<Schema\TeamProject>|Observable<Schema\CodeScanningAlertItems>|Observable<Schema\CodeScanningAnalysis>|Observable<Schema\DependabotAlert>|Observable<Schema\PorterAuthor>|Observable<Schema\PorterLargeFile>|Observable<Schema\IssueComment>|Observable<Schema\IssueEvent>|Observable<Schema\PageBuild>|Observable<Schema\CustomPropertyValue>|Observable<Schema\PullRequestReviewComment>|Schema\PullRequest|\ApiClients\Tools\OpenApiClient\Utils\Response\WithoutBody|Observable<Schema\RuleSuites>|Observable<Schema\SecretScanningAlert>|Observable<int>|Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\CommitActivity>|Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\ContributorActivity>|Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\TagProtection>|Observable<Schema\TeamDiscussionComment>|Observable<Schema\Reaction>|Observable<Schema\PackageVersion>|Observable<Schema\Event> */
76+
/** @return Observable<Schema\MarketplacePurchase>||Observable<Schema\RunnerApplication>|Observable<Schema\HookDeliveryItem>|Observable<Schema\Team>|Observable<Schema\MinimalRepository>|WithoutBody|Observable<Schema\SimpleUser>|Observable<Schema\TeamDiscussion>|Observable<Schema\OrganizationInvitation>|Observable<Schema\TeamProject>|Observable<Schema\CodeScanningAlertItems>|Observable<Schema\CodeScanningAnalysis>|Observable<Schema\DependabotAlert>|Observable<Schema\PorterAuthor>|Observable<Schema\PorterLargeFile>|Observable<Schema\IssueComment>|Observable<Schema\IssueEvent>|Observable<Schema\PageBuild>|Observable<Schema\CustomPropertyValue>|Observable<Schema\PullRequestReviewComment>|Observable<Schema\RuleSuites>|Observable<Schema\SecretScanningAlert>|Observable<int>|Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\CommitActivity>|Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\ContributorActivity>|Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|Observable<Schema\TagProtection>|Observable<Schema\TeamDiscussionComment>|Observable<Schema\Reaction>|Observable<Schema\PackageVersion>|Observable<Schema\Event> */
7777
public function call(string $call, array $params, array $pathChunks): iterable|ActionsCacheUsageOrgEnterprise|Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListSelectedRepositoriesEnabledGithubActionsOrganization\Response\ApplicationJson\Ok|SelectedActions|ActionsGetDefaultWorkflowPermissions|Runner|ActionsPublicKey|OrganizationActionsSecret|OrganizationActionsVariable|CodespacesPublicKey|CodespacesOrgSecret|\ApiClients\Client\GitHub\Schema\Operations\Copilot\ListCopilotSeats\Response\ApplicationJson\Ok|DependabotPublicKey|OrganizationDependabotSecret|WebhookConfig|Json|WithoutBody|CopilotSeatDetails|Package|OrgCustomProperty|RuleSuite|ActionsBillingUsage|PackagesBillingUsage|CombinedBillingUsage|ProjectCollaboratorPermission|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListArtifactsForRepo\Response\ApplicationJson\Ok|ActionsCacheList|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoOrganizationSecrets\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoOrganizationVariables\Response\ApplicationJson\Ok|ActionsRepositoryPermissions|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListSelfHostedRunnersForRepo\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListWorkflowRunsForRepo\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoSecrets\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoVariables\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListRepoWorkflows\Response\ApplicationJson\Ok|Autolink|BranchWithProtection|BasicError|CheckRun|CheckSuite|CodeScanningDefaultSetup|CodeownersErrors|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListDevcontainersInRepositoryForAuthenticatedUser\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\RepoMachinesForAuthenticatedUser\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\PreFlightWithRepoForAuthenticatedUser\Response\ApplicationJson\Ok|CodespacesPermissionsCheckForDevcontainer|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListRepoSecrets\Response\ApplicationJson\Ok|CommitComment|Commit|CommunityProfile|CommitComparison|ContentDirectory|ContentFile|ContentSymlink|ContentSubmodule|\ApiClients\Client\GitHub\Schema\Operations\Dependabot\ListRepoSecrets\Response\ApplicationJson\Ok|DependencyGraphSpdxSbom|Deployment|Environment|Hook|Issue|DeployKey|Label|Milestone|PagesHealthCheck|EmptyObject|PullRequest|Release|RepositoryRuleset|RepositoryAdvisory|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetCodeFrequencyStats\Response\ApplicationJson\Accepted\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetCommitActivityStats\Response\ApplicationJson\Accepted\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetContributorsStats\Response\ApplicationJson\Accepted\Application\Json|ParticipationStats|CloneTraffic|ViewTraffic|TeamRepository|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListRepositoriesForSecretForAuthenticatedUser\Response\ApplicationJson\Ok\Application\Json|CodespaceExportDetails
7878
{
7979
if ($pathChunks[0] === '') {

clients/GitHub/src/Operation/Pulls.php

+1
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ public function updateReviewComment(string $owner, string $repo, int $commentId,
6969
return $this->operators->pulls👷UpdateReviewComment()->call($owner, $repo, $commentId, $params);
7070
}
7171

72+
/** @return */
7273
public function get(string $owner, string $repo, int $pullNumber): PullRequest|WithoutBody
7374
{
7475
return $this->operators->pulls👷Get()->call($owner, $repo, $pullNumber);

clients/GitHub/src/PHPStan/ClientCallReturnTypes.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -3152,7 +3152,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
31523152
}
31533153

31543154
if ($call === 'GET /repos/{owner}/{repo}/pulls/{pull_number}') {
3155-
return $this->typeResolver->resolve('Schema\\PullRequest|\\ApiClients\\Tools\\OpenApiClient\\Utils\\Response\\WithoutBody');
3155+
return $this->typeResolver->resolve('');
31563156
}
31573157

31583158
if ($call === 'PATCH /repos/{owner}/{repo}/pulls/{pull_number}') {

clients/GitHub/src/Schema/Orgs/Update/Request/ApplicationJson.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
},
3838
"description": {
3939
"type": "string",
40-
"description": "The description of the company."
40+
"description": "The description of the company. The maximum size is 160 characters."
4141
},
4242
"has_organization_projects": {
4343
"type": "boolean",
@@ -190,7 +190,7 @@
190190
* twitterUsername: The Twitter username of the company.
191191
* location: The location.
192192
* name: The shorthand name of the company.
193-
* description: The description of the company.
193+
* description: The description of the company. The maximum size is 160 characters.
194194
* hasOrganizationProjects: Whether an organization can use organization projects.
195195
* hasRepositoryProjects: Whether repositories that belong to the organization can use repository projects.
196196
* defaultRepositoryPermission: Default permission level members have for organization repositories.

clients/GitHub/src/Schema/RepositoryRuleParamsCodeScanningThreshold.php

-65
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace ApiClients\Client\GitHub\Schema;
6+
7+
use EventSauce\ObjectHydrator\MapFrom;
8+
9+
final readonly class RepositoryRuleParamsCodeScanningTool
10+
{
11+
public const SCHEMA_JSON = '{
12+
"title": "CodeScanningTool",
13+
"required": [
14+
"alerts_threshold",
15+
"security_alerts_threshold",
16+
"tool"
17+
],
18+
"type": "object",
19+
"properties": {
20+
"alerts_threshold": {
21+
"enum": [
22+
"none",
23+
"errors",
24+
"errors_and_warnings",
25+
"all"
26+
],
27+
"type": "string",
28+
"description": "The threshold at which code scanning results that introduce alerts block a ref update."
29+
},
30+
"security_alerts_threshold": {
31+
"enum": [
32+
"none",
33+
"critical",
34+
"high_or_higher",
35+
"medium_or_higher",
36+
"all"
37+
],
38+
"type": "string",
39+
"description": "The threshold at which code scanning results that introduce security alerts block a ref update."
40+
},
41+
"tool": {
42+
"type": "string",
43+
"description": "The name of a code scanning tool"
44+
}
45+
},
46+
"description": "A tool that must provide code scanning results for this rule to pass."
47+
}';
48+
public const SCHEMA_TITLE = 'CodeScanningTool';
49+
public const SCHEMA_DESCRIPTION = 'A tool that must provide code scanning results for this rule to pass.';
50+
public const SCHEMA_EXAMPLE_DATA = '{
51+
"alerts_threshold": "all",
52+
"security_alerts_threshold": "none",
53+
"tool": "generated"
54+
}';
55+
56+
/**
57+
* alertsThreshold: The threshold at which code scanning results that introduce alerts block a ref update.
58+
* securityAlertsThreshold: The threshold at which code scanning results that introduce security alerts block a ref update.
59+
* tool: The name of a code scanning tool
60+
*/
61+
public function __construct(#[MapFrom('alerts_threshold')]
62+
public string $alertsThreshold, #[MapFrom('security_alerts_threshold')]
63+
public string $securityAlertsThreshold, public string $tool,)
64+
{
65+
}
66+
}

clients/GitHub/tests/Types/ClientCallReturnTypes.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ function authHeader(): string
794794
assertType('Observable<Schema\\Reaction>', $client->call('LIST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions'));
795795
assertType('', $client->call('POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions'));
796796
assertType('', $client->call('DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}'));
797-
assertType('Schema\\PullRequest|\\ApiClients\\Tools\\OpenApiClient\\Utils\\Response\\WithoutBody', $client->call('GET /repos/{owner}/{repo}/pulls/{pull_number}'));
797+
assertType('', $client->call('GET /repos/{owner}/{repo}/pulls/{pull_number}'));
798798
assertType('', $client->call('PATCH /repos/{owner}/{repo}/pulls/{pull_number}'));
799799
assertType('', $client->call('POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces'));
800800
assertType('Observable<Schema\\PullRequestReviewComment>', $client->call('GET /repos/{owner}/{repo}/pulls/{pull_number}/comments'));

0 commit comments

Comments
 (0)