Skip to content

Commit ea62c67

Browse files
JulianVennenJulianVennen
authored
[php][php-nextgen] Cleanup api authentication code when using api keys in cookies or supporting multiple authentication methods (#22433)
1 parent 6be8fb3 commit ea62c67

File tree

17 files changed

+8
-94
lines changed

17 files changed

+8
-94
lines changed

‎modules/openapi-generator/src/main/resources/php-nextgen/api.mustache‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -786,34 +786,39 @@ use {{invokerPackage}}\ObjectSerializer;
786786

787787
{{#authMethods}}
788788
{{#isApiKey}}
789+
{{^isKeyInCookie}}
789790
// this endpoint requires API key authentication
790791
$apiKey = $this->config->getApiKeyWithPrefix('{{keyParamName}}');
791792
if ($apiKey !== null) {
792793
{{#isKeyInHeader}}$headers['{{keyParamName}}'] = $apiKey;{{/isKeyInHeader}}{{#isKeyInQuery}}$queryParams['{{keyParamName}}'] = $apiKey;{{/isKeyInQuery}}
793794
}
795+
796+
{{/isKeyInCookie}}
794797
{{/isApiKey}}
795798
{{#isBasic}}
796799
{{#isBasicBasic}}
797800
// this endpoint requires HTTP basic authentication
798801
if (!empty($this->config->getUsername()) || !(empty($this->config->getPassword()))) {
799802
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
800803
}
804+
801805
{{/isBasicBasic}}
802806
{{#isBasicBearer}}
803807
// this endpoint requires Bearer{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} authentication (access token)
804808
if (!empty($this->config->getAccessToken())) {
805809
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
806810
}
811+
807812
{{/isBasicBearer}}
808813
{{/isBasic}}
809814
{{#isOAuth}}
810815
// this endpoint requires OAuth (access token)
811816
if (!empty($this->config->getAccessToken())) {
812817
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
813818
}
819+
814820
{{/isOAuth}}
815821
{{/authMethods}}
816-
817822
$defaultHeaders = [];
818823
if ($this->config->getUserAgent()) {
819824
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎modules/openapi-generator/src/main/resources/php/api.mustache‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -711,11 +711,13 @@ use {{invokerPackage}}\ObjectSerializer;
711711

712712
{{#authMethods}}
713713
{{#isApiKey}}
714+
{{^isKeyInCookie}}
714715
// this endpoint requires API key authentication
715716
$apiKey = $this->config->getApiKeyWithPrefix('{{keyParamName}}');
716717
if ($apiKey !== null) {
717718
{{#isKeyInHeader}}$headers['{{keyParamName}}'] = $apiKey;{{/isKeyInHeader}}{{#isKeyInQuery}}$queryParams['{{keyParamName}}'] = $apiKey;{{/isKeyInQuery}}
718719
}
720+
{{/isKeyInCookie}}
719721
{{/isApiKey}}
720722
{{#isBasic}}
721723
{{#isBasicBasic}}

‎samples/client/echo_api/php-nextgen-streaming/src/Api/BodyApi.php‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,6 @@ public function testBinaryGifRequest(
386386
}
387387
}
388388

389-
390389
$defaultHeaders = [];
391390
if ($this->config->getUserAgent()) {
392391
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -659,7 +658,6 @@ public function testBodyApplicationOctetstreamBinaryRequest(
659658
}
660659
}
661660

662-
663661
$defaultHeaders = [];
664662
if ($this->config->getUserAgent()) {
665663
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -940,7 +938,6 @@ public function testBodyMultipartFormdataArrayOfBinaryRequest(
940938
}
941939
}
942940

943-
944941
$defaultHeaders = [];
945942
if ($this->config->getUserAgent()) {
946943
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1215,7 +1212,6 @@ public function testBodyMultipartFormdataSingleBinaryRequest(
12151212
}
12161213
}
12171214

1218-
12191215
$defaultHeaders = [];
12201216
if ($this->config->getUserAgent()) {
12211217
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1488,7 +1484,6 @@ public function testEchoBodyAllOfPetRequest(
14881484
}
14891485
}
14901486

1491-
14921487
$defaultHeaders = [];
14931488
if ($this->config->getUserAgent()) {
14941489
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1761,7 +1756,6 @@ public function testEchoBodyFreeFormObjectResponseStringRequest(
17611756
}
17621757
}
17631758

1764-
17651759
$defaultHeaders = [];
17661760
if ($this->config->getUserAgent()) {
17671761
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2034,7 +2028,6 @@ public function testEchoBodyPetRequest(
20342028
}
20352029
}
20362030

2037-
20382031
$defaultHeaders = [];
20392032
if ($this->config->getUserAgent()) {
20402033
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2307,7 +2300,6 @@ public function testEchoBodyPetResponseStringRequest(
23072300
}
23082301
}
23092302

2310-
23112303
$defaultHeaders = [];
23122304
if ($this->config->getUserAgent()) {
23132305
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2580,7 +2572,6 @@ public function testEchoBodyStringEnumRequest(
25802572
}
25812573
}
25822574

2583-
25842575
$defaultHeaders = [];
25852576
if ($this->config->getUserAgent()) {
25862577
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2853,7 +2844,6 @@ public function testEchoBodyTagResponseStringRequest(
28532844
}
28542845
}
28552846

2856-
28572847
$defaultHeaders = [];
28582848
if ($this->config->getUserAgent()) {
28592849
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen-streaming/src/Api/FormApi.php‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,6 @@ public function testFormIntegerBooleanStringRequest(
409409
}
410410
}
411411

412-
413412
$defaultHeaders = [];
414413
if ($this->config->getUserAgent()) {
415414
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -690,7 +689,6 @@ public function testFormObjectMultipartRequest(
690689
}
691690
}
692691

693-
694692
$defaultHeaders = [];
695693
if ($this->config->getUserAgent()) {
696694
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1025,7 +1023,6 @@ public function testFormOneofRequest(
10251023
}
10261024
}
10271025

1028-
10291026
$defaultHeaders = [];
10301027
if ($this->config->getUserAgent()) {
10311028
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen-streaming/src/Api/HeaderApi.php‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,6 @@ public function testHeaderIntegerBooleanStringEnumsRequest(
434434
}
435435
}
436436

437-
438437
$defaultHeaders = [];
439438
if ($this->config->getUserAgent()) {
440439
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen-streaming/src/Api/PathApi.php‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,6 @@ public function testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathE
459459
}
460460
}
461461

462-
463462
$defaultHeaders = [];
464463
if ($this->config->getUserAgent()) {
465464
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen-streaming/src/Api/QueryApi.php‎

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,6 @@ public function testEnumRefStringRequest(
429429
}
430430
}
431431

432-
433432
$defaultHeaders = [];
434433
if ($this->config->getUserAgent()) {
435434
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -744,7 +743,6 @@ public function testQueryDatetimeDateStringRequest(
744743
}
745744
}
746745

747-
748746
$defaultHeaders = [];
749747
if ($this->config->getUserAgent()) {
750748
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1059,7 +1057,6 @@ public function testQueryIntegerBooleanStringRequest(
10591057
}
10601058
}
10611059

1062-
10631060
$defaultHeaders = [];
10641061
if ($this->config->getUserAgent()) {
10651062
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1334,7 +1331,6 @@ public function testQueryStyleDeepObjectExplodeTrueObjectRequest(
13341331
}
13351332
}
13361333

1337-
13381334
$defaultHeaders = [];
13391335
if ($this->config->getUserAgent()) {
13401336
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1609,7 +1605,6 @@ public function testQueryStyleDeepObjectExplodeTrueObjectAllOfRequest(
16091605
}
16101606
}
16111607

1612-
16131608
$defaultHeaders = [];
16141609
if ($this->config->getUserAgent()) {
16151610
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1884,7 +1879,6 @@ public function testQueryStyleFormExplodeFalseArrayIntegerRequest(
18841879
}
18851880
}
18861881

1887-
18881882
$defaultHeaders = [];
18891883
if ($this->config->getUserAgent()) {
18901884
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2159,7 +2153,6 @@ public function testQueryStyleFormExplodeFalseArrayStringRequest(
21592153
}
21602154
}
21612155

2162-
21632156
$defaultHeaders = [];
21642157
if ($this->config->getUserAgent()) {
21652158
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2434,7 +2427,6 @@ public function testQueryStyleFormExplodeTrueArrayStringRequest(
24342427
}
24352428
}
24362429

2437-
24382430
$defaultHeaders = [];
24392431
if ($this->config->getUserAgent()) {
24402432
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2709,7 +2701,6 @@ public function testQueryStyleFormExplodeTrueObjectRequest(
27092701
}
27102702
}
27112703

2712-
27132704
$defaultHeaders = [];
27142705
if ($this->config->getUserAgent()) {
27152706
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2984,7 +2975,6 @@ public function testQueryStyleFormExplodeTrueObjectAllOfRequest(
29842975
}
29852976
}
29862977

2987-
29882978
$defaultHeaders = [];
29892979
if ($this->config->getUserAgent()) {
29902980
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -3279,7 +3269,6 @@ public function testQueryStyleJsonSerializationObjectRequest(
32793269
}
32803270
}
32813271

3282-
32833272
$defaultHeaders = [];
32843273
if ($this->config->getUserAgent()) {
32853274
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen/src/Api/BodyApi.php‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -386,7 +386,6 @@ public function testBinaryGifRequest(
386386
}
387387
}
388388

389-
390389
$defaultHeaders = [];
391390
if ($this->config->getUserAgent()) {
392391
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -659,7 +658,6 @@ public function testBodyApplicationOctetstreamBinaryRequest(
659658
}
660659
}
661660

662-
663661
$defaultHeaders = [];
664662
if ($this->config->getUserAgent()) {
665663
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -940,7 +938,6 @@ public function testBodyMultipartFormdataArrayOfBinaryRequest(
940938
}
941939
}
942940

943-
944941
$defaultHeaders = [];
945942
if ($this->config->getUserAgent()) {
946943
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1215,7 +1212,6 @@ public function testBodyMultipartFormdataSingleBinaryRequest(
12151212
}
12161213
}
12171214

1218-
12191215
$defaultHeaders = [];
12201216
if ($this->config->getUserAgent()) {
12211217
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1488,7 +1484,6 @@ public function testEchoBodyAllOfPetRequest(
14881484
}
14891485
}
14901486

1491-
14921487
$defaultHeaders = [];
14931488
if ($this->config->getUserAgent()) {
14941489
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1761,7 +1756,6 @@ public function testEchoBodyFreeFormObjectResponseStringRequest(
17611756
}
17621757
}
17631758

1764-
17651759
$defaultHeaders = [];
17661760
if ($this->config->getUserAgent()) {
17671761
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2034,7 +2028,6 @@ public function testEchoBodyPetRequest(
20342028
}
20352029
}
20362030

2037-
20382031
$defaultHeaders = [];
20392032
if ($this->config->getUserAgent()) {
20402033
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2307,7 +2300,6 @@ public function testEchoBodyPetResponseStringRequest(
23072300
}
23082301
}
23092302

2310-
23112303
$defaultHeaders = [];
23122304
if ($this->config->getUserAgent()) {
23132305
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2580,7 +2572,6 @@ public function testEchoBodyStringEnumRequest(
25802572
}
25812573
}
25822574

2583-
25842575
$defaultHeaders = [];
25852576
if ($this->config->getUserAgent()) {
25862577
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -2853,7 +2844,6 @@ public function testEchoBodyTagResponseStringRequest(
28532844
}
28542845
}
28552846

2856-
28572847
$defaultHeaders = [];
28582848
if ($this->config->getUserAgent()) {
28592849
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen/src/Api/FormApi.php‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,6 @@ public function testFormIntegerBooleanStringRequest(
409409
}
410410
}
411411

412-
413412
$defaultHeaders = [];
414413
if ($this->config->getUserAgent()) {
415414
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -690,7 +689,6 @@ public function testFormObjectMultipartRequest(
690689
}
691690
}
692691

693-
694692
$defaultHeaders = [];
695693
if ($this->config->getUserAgent()) {
696694
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
@@ -1025,7 +1023,6 @@ public function testFormOneofRequest(
10251023
}
10261024
}
10271025

1028-
10291026
$defaultHeaders = [];
10301027
if ($this->config->getUserAgent()) {
10311028
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

‎samples/client/echo_api/php-nextgen/src/Api/HeaderApi.php‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,6 @@ public function testHeaderIntegerBooleanStringEnumsRequest(
434434
}
435435
}
436436

437-
438437
$defaultHeaders = [];
439438
if ($this->config->getUserAgent()) {
440439
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();

0 commit comments

Comments
 (0)