Skip to content

Commit cad7b32

Browse files
authored
Merge pull request #1096 from php-api-clients/GitHub/from-1.1.4-b56f269fa7811532d191d959eab59a6b-from-1.1.4-b56f269fa7811532d191d959eab59a6b
2 parents 767b784 + 4bfdbbc commit cad7b32

File tree

11 files changed

+39
-28
lines changed

11 files changed

+39
-28
lines changed

clients/GitHub/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17676,13 +17676,15 @@ Using the `call` method:
1767617676
$client->call('GET /repos/{owner}/{repo}/license', [
1767717677
'owner' => 'generated',
1767817678
'repo' => 'generated',
17679+
'ref' => 'generated',
1767917680
]);
1768017681
```
1768117682

1768217683
Operations method:
1768317684
```php
1768417685
$client->operations()->licenses()->getForRepo( owner: 'generated',
1768517686
repo: 'generated',
17687+
ref: 'generated',
1768617688
);
1768717689
```
1768817690

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"specHash": "2bcf4a7ffd1c08c4653f4fa12fbb7e3f",
2+
"specHash": "b56f269fa7811532d191d959eab59a6b",
33
"generatedFiles": {
44
"files": [
55
{
@@ -5756,7 +5756,7 @@
57565756
},
57575757
{
57585758
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Licenses.php",
5759-
"hash": "7c5326d1d574b9efdd3619ac4e0c3670"
5759+
"hash": "cd7dd0390e80643ada325b5e346a44b0"
57605760
},
57615761
{
57625762
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Operation\/Markdown.php",
@@ -21828,15 +21828,15 @@
2182821828
},
2182921829
{
2183021830
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Licenses\/GetForRepo.php",
21831-
"hash": "d39d1d47862837d138b2e749e295a068"
21831+
"hash": "77c035595b91d5878035f51019cfd6b0"
2183221832
},
2183321833
{
2183421834
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operator\/Licenses\/GetForRepo.php",
21835-
"hash": "49069ec06b26280f205df1c6bc1b2b14"
21835+
"hash": "b766a41e249ffdf739d434f8edff0c29"
2183621836
},
2183721837
{
2183821838
"name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Internal\/Operation\/Licenses\/GetForRepoTest.php",
21839-
"hash": "00b555c093f752b22eaa6d8e0c4e6082"
21839+
"hash": "07daedeba23c59ee46b7300d3b337c12"
2184021840
},
2184121841
{
2184221842
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Operation\/Repos\/MergeUpstream.php",
@@ -26348,7 +26348,7 @@
2634826348
},
2634926349
{
2635026350
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Licenses.php",
26351-
"hash": "e40d398894a18c495c8bf4436613e8d9"
26351+
"hash": "d016a7acdd3c9e968869ebc52993241e"
2635226352
},
2635326353
{
2635426354
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Orgs.php",
@@ -26852,7 +26852,7 @@
2685226852
},
2685326853
{
2685426854
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Five.php",
26855-
"hash": "a74e39ca54dba0682475b255dcea9c6d"
26855+
"hash": "b910424e796b3b1a789a1a8d2fd1c0a7"
2685626856
},
2685726857
{
2685826858
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/Internal\/Router\/Get\/Six.php",
@@ -29708,11 +29708,11 @@
2970829708
},
2970929709
{
2971029710
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/PHPStan\/ClientCallReturnTypes.php",
29711-
"hash": "deef79abe0f45342aaf83a90f84ecb93"
29711+
"hash": "9fe2d0166d211fbd94b58c43385b0465"
2971229712
},
2971329713
{
2971429714
"name": ".\/clients\/GitHub\/etc\/..\/\/tests\/\/Types\/ClientCallReturnTypes.php",
29715-
"hash": "991da0fe5ffea896a5600ac51aae08c8"
29715+
"hash": "f4ab17a66cac87bfd47ccd52ba95d301"
2971629716
},
2971729717
{
2971829718
"name": ".\/clients\/GitHub\/etc\/..\/\/src\/\/..\/etc\/phpstan-extension.neon",

clients/GitHub/src/Internal/Operation/Licenses/GetForRepo.php

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,19 @@ final class GetForRepo
2626
private string $owner;
2727
/**The name of the repository without the `.git` extension. The name is not case sensitive. **/
2828
private string $repo;
29+
/**The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`. **/
30+
private string $ref;
2931

30-
public function __construct(private readonly SchemaValidator $responseSchemaValidator, private readonly Internal\Hydrator\Operation\Repos\Owner\Repo\License $hydrator, string $owner, string $repo)
32+
public function __construct(private readonly SchemaValidator $responseSchemaValidator, private readonly Internal\Hydrator\Operation\Repos\Owner\Repo\License $hydrator, string $owner, string $repo, string $ref)
3133
{
3234
$this->owner = $owner;
3335
$this->repo = $repo;
36+
$this->ref = $ref;
3437
}
3538

3639
public function createRequest(): RequestInterface
3740
{
38-
return new Request('GET', str_replace(['{owner}', '{repo}'], [$this->owner, $this->repo], '/repos/{owner}/{repo}/license'));
41+
return new Request('GET', str_replace(['{owner}', '{repo}', '{ref}'], [$this->owner, $this->repo, $this->ref], '/repos/{owner}/{repo}/license' . '?ref={ref}'));
3942
}
4043

4144
public function createResponse(ResponseInterface $response): Schema\LicenseContent

clients/GitHub/src/Internal/Operator/Licenses/GetForRepo.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,9 @@ public function __construct(private Browser $browser, private AuthenticationInte
2424
{
2525
}
2626

27-
/** @return */
28-
public function call(string $owner, string $repo): LicenseContent
27+
public function call(string $owner, string $repo, string $ref): LicenseContent
2928
{
30-
$operation = new \ApiClients\Client\GitHub\Internal\Operation\Licenses\GetForRepo($this->responseSchemaValidator, $this->hydrator, $owner, $repo);
29+
$operation = new \ApiClients\Client\GitHub\Internal\Operation\Licenses\GetForRepo($this->responseSchemaValidator, $this->hydrator, $owner, $repo, $ref);
3130
$request = $operation->createRequest();
3231
$result = await($this->browser->request($request->getMethod(), (string) $request->getUri(), $request->withHeader('Authorization', $this->authentication->authHeader())->getHeaders(), (string) $request->getBody())->then(static function (ResponseInterface $response) use ($operation): LicenseContent {
3332
return $operation->createResponse($response);

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public function __construct(private Routers $routers)
4949
{
5050
}
5151

52-
/** @return |Observable<Schema\DependabotAlertWithRepository>|WithoutBody|Observable<Schema\OrganizationSecretScanningAlert>|Observable<Schema\MarketplacePurchase>|Observable<Schema\Event>|Schema\BasicError|Observable<Schema\CodeScanningOrganizationAlertItems>|Observable<Schema\Package>|Observable<Schema\OrgCustomProperty>|Observable<Schema\OrgRepoCustomPropertyValues>|Observable<Schema\RuleSuites>|Observable<Schema\ProjectCard>|Observable<Schema\Activity>|Observable<Schema\SimpleUser>|Observable<Schema\Autolink>|Observable<Schema\ShortBranch>|Observable<Schema\Collaborator>|Observable<Schema\CommitComment>|Observable<Schema\Commit>|Observable<Schema\Contributor>|Observable<Schema\Deployment>|Observable<Schema\MinimalRepository>|Observable<Schema\Hook>|Observable<Schema\RepositoryInvitation>|Observable<Schema\Issue>|Observable<Schema\DeployKey>|Observable<Schema\Label>|Observable<Schema\Milestone>|Observable<Schema\Thread>|Observable<Schema\Project>|Observable<Schema\PullRequestSimple>|Observable<Schema\Release>|Observable<Schema\RepositoryRuleset>|Observable<Schema\RepositoryAdvisory>|Observable<Schema\Tag>|Observable<Schema\Team> */
52+
/** @return |Observable<Schema\DependabotAlertWithRepository>|WithoutBody|Observable<Schema\OrganizationSecretScanningAlert>|Observable<Schema\MarketplacePurchase>|Observable<Schema\Event>|Schema\BasicError|Observable<Schema\CodeScanningOrganizationAlertItems>|Observable<Schema\Package>|Observable<Schema\OrgCustomProperty>|Observable<Schema\OrgRepoCustomPropertyValues>|Observable<Schema\RuleSuites>|Observable<Schema\ProjectCard>|Observable<Schema\Activity>|Observable<Schema\SimpleUser>|Observable<Schema\Autolink>|Observable<Schema\ShortBranch>|Observable<Schema\Collaborator>|Observable<Schema\CommitComment>|Observable<Schema\Commit>|Observable<Schema\Contributor>|Observable<Schema\Deployment>|Observable<Schema\MinimalRepository>|Observable<Schema\Hook>|Observable<Schema\RepositoryInvitation>|Observable<Schema\Issue>|Observable<Schema\DeployKey>|Observable<Schema\Label>|Schema\LicenseContent|Observable<Schema\Milestone>|Observable<Schema\Thread>|Observable<Schema\Project>|Observable<Schema\PullRequestSimple>|Observable<Schema\Release>|Observable<Schema\RepositoryRuleset>|Observable<Schema\RepositoryAdvisory>|Observable<Schema\Tag>|Observable<Schema\Team> */
5353
public function call(string $call, array $params, array $pathChunks): HookDelivery|iterable|WithoutBody|GistComment|MarketplacePurchase|BasicError|ThreadSubscription|ActionsOrganizationPermissions|Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListOrgSecrets\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Actions\ListOrgVariables\Response\ApplicationJson\Ok|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\ListOrgSecrets\Response\ApplicationJson\Ok|CopilotOrganizationDetails|\ApiClients\Client\GitHub\Schema\Operations\Dependabot\ListOrgSecrets\Response\ApplicationJson\Ok|OrgHook|OrgMembership|Migration|OrganizationRole|RepositoryRuleset|TeamFull|ProjectCard|CheckAutomatedSecurityFixes|Json|\ApiClients\Client\GitHub\Schema\Operations\Repos\GetAllEnvironments\Response\ApplicationJson\Ok|Import|Installation|InteractionLimitResponse|One|Language|LicenseContent|Page|ContentFile|SimpleUser|Stargazer|RepositorySubscription|Topic|TeamDiscussion|TeamMembership|TeamProject|CodespacesUserPublicKey|CodespacesSecret|\ApiClients\Client\GitHub\Schema\Operations\Codespaces\CodespaceMachinesForAuthenticatedUser\Response\ApplicationJson\Ok\Application\Json|\ApiClients\Client\GitHub\Schema\Operations\Apps\ListInstallationReposForAuthenticatedUser\Response\ApplicationJson\Ok|Package
5454
{
5555
if ($pathChunks[0] === '') {

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

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,6 @@ public function get(array $params): License|WithoutBody
6464
return $operator->call($arguments['license']);
6565
}
6666

67-
/** @return */
6867
public function getForRepo(array $params): LicenseContent
6968
{
7069
$arguments = [];
@@ -80,8 +79,14 @@ public function getForRepo(array $params): LicenseContent
8079

8180
$arguments['repo'] = $params['repo'];
8281
unset($params['repo']);
82+
if (array_key_exists('ref', $params) === false) {
83+
throw new InvalidArgumentException('Missing mandatory field: ref');
84+
}
85+
86+
$arguments['ref'] = $params['ref'];
87+
unset($params['ref']);
8388
$operator = new Internal\Operator\Licenses\GetForRepo($this->browser, $this->authentication, $this->responseSchemaValidator, $this->hydrators->getObjectMapperOperation🌀Repos🌀Owner🌀Repo🌀License());
8489

85-
return $operator->call($arguments['owner'], $arguments['repo']);
90+
return $operator->call($arguments['owner'], $arguments['repo'], $arguments['ref']);
8691
}
8792
}

clients/GitHub/src/Operation/Licenses.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,8 @@ public function get(string $license): License|WithoutBody
3434
return $this->operators->licenses👷Get()->call($license);
3535
}
3636

37-
/** @return */
38-
public function getForRepo(string $owner, string $repo): LicenseContent
37+
public function getForRepo(string $owner, string $repo, string $ref): LicenseContent
3938
{
40-
return $this->operators->licenses👷GetForRepo()->call($owner, $repo);
39+
return $this->operators->licenses👷GetForRepo()->call($owner, $repo, $ref);
4140
}
4241
}

clients/GitHub/src/PHPStan/ClientCallReturnTypes.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2924,7 +2924,7 @@ public function getTypeFromMethodCall(MethodReflection $methodReflection, Method
29242924
}
29252925

29262926
if ($call === 'GET /repos/{owner}/{repo}/license') {
2927-
return $this->typeResolver->resolve('');
2927+
return $this->typeResolver->resolve('Schema\\LicenseContent');
29282928
}
29292929

29302930
if ($call === 'POST /repos/{owner}/{repo}/merge-upstream') {

clients/GitHub/tests/Internal/Operation/Licenses/GetForRepoTest.php

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ public function call_httpCode_200_responseContentType_application_json_zero(): v
3030
$browser = $this->prophesize(Browser::class);
3131
$browser->withBase(Argument::any())->willReturn($browser->reveal());
3232
$browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
33-
$browser->request('GET', '/repos/generated/generated/license', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
33+
$browser->request('GET', '/repos/generated/generated/license?ref=generated', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
3434
$client = new Client($auth->reveal(), $browser->reveal());
3535
$result = $client->call(Internal\Operation\Licenses\GetForRepo::OPERATION_MATCH, (static function (array $data): array {
3636
$data['owner'] = 'generated';
3737
$data['repo'] = 'generated';
38+
$data['ref'] = 'generated';
3839

3940
return $data;
4041
})([]));
@@ -49,9 +50,9 @@ public function operations_httpCode_200_responseContentType_application_json_zer
4950
$browser = $this->prophesize(Browser::class);
5051
$browser->withBase(Argument::any())->willReturn($browser->reveal());
5152
$browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
52-
$browser->request('GET', '/repos/generated/generated/license', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
53+
$browser->request('GET', '/repos/generated/generated/license?ref=generated', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
5354
$client = new Client($auth->reveal(), $browser->reveal());
54-
$result = $client->operations()->licenses()->getForRepo('generated', 'generated');
55+
$result = $client->operations()->licenses()->getForRepo('generated', 'generated', 'generated');
5556
}
5657

5758
/** @test */
@@ -64,11 +65,12 @@ public function call_httpCode_404_responseContentType_application_json_zero(): v
6465
$browser = $this->prophesize(Browser::class);
6566
$browser->withBase(Argument::any())->willReturn($browser->reveal());
6667
$browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
67-
$browser->request('GET', '/repos/generated/generated/license', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
68+
$browser->request('GET', '/repos/generated/generated/license?ref=generated', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
6869
$client = new Client($auth->reveal(), $browser->reveal());
6970
$result = $client->call(Internal\Operation\Licenses\GetForRepo::OPERATION_MATCH, (static function (array $data): array {
7071
$data['owner'] = 'generated';
7172
$data['repo'] = 'generated';
73+
$data['ref'] = 'generated';
7274

7375
return $data;
7476
})([]));
@@ -84,8 +86,8 @@ public function operations_httpCode_404_responseContentType_application_json_zer
8486
$browser = $this->prophesize(Browser::class);
8587
$browser->withBase(Argument::any())->willReturn($browser->reveal());
8688
$browser->withFollowRedirects(Argument::any())->willReturn($browser->reveal());
87-
$browser->request('GET', '/repos/generated/generated/license', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
89+
$browser->request('GET', '/repos/generated/generated/license?ref=generated', Argument::type('array'), Argument::any())->willReturn(resolve($response))->shouldBeCalled();
8890
$client = new Client($auth->reveal(), $browser->reveal());
89-
$result = $client->operations()->licenses()->getForRepo('generated', 'generated');
91+
$result = $client->operations()->licenses()->getForRepo('generated', 'generated', 'generated');
9092
}
9193
}

clients/GitHub/tests/Types/ClientCallReturnTypes.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -737,7 +737,7 @@ function authHeader(): string
737737
assertType('', $client->call('DELETE /repos/{owner}/{repo}/labels/{name}'));
738738
assertType('', $client->call('PATCH /repos/{owner}/{repo}/labels/{name}'));
739739
assertType('', $client->call('GET /repos/{owner}/{repo}/languages'));
740-
assertType('', $client->call('GET /repos/{owner}/{repo}/license'));
740+
assertType('Schema\\LicenseContent', $client->call('GET /repos/{owner}/{repo}/license'));
741741
assertType('', $client->call('POST /repos/{owner}/{repo}/merge-upstream'));
742742
assertType('', $client->call('POST /repos/{owner}/{repo}/merges'));
743743
assertType('Observable<Schema\\Milestone>', $client->call('GET /repos/{owner}/{repo}/milestones'));

0 commit comments

Comments
 (0)