loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[php] fix documentation of API authorization in README files (#15306)

Browse Source 
fix hierarchy level + align wording across generators
This commit is contained in:
Tiffany Marrel 2023-05-09 08:25:14 +02:00 committed by GitHub
parent 4deaad557e
commit 9cb14aeb8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
modules/openapi-generator/src/main/resources/php-symfony/README.mustache vendored
View File

@ -147,9 +147,10 @@ Class | Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
{{^authMethods}} All endpoints do not require authorization. {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
{{/authMethods}}{{#authMethods}}{{#last}} Authentication schemes defined for the API:{{/last}}{{/authMethods}} {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{#authMethods}}## {{{name}}} {{#authMethods}}
### {{{name}}}
{{#isApiKey}}- **Type**: API key {{#isApiKey}}- **Type**: API key
- **API key parameter name**: {{{keyParamName}}} - **API key parameter name**: {{{keyParamName}}}

6
modules/openapi-generator/src/main/resources/php/README.mustache vendored
View File

@ -86,11 +86,9 @@ Class | Method | HTTP request | Description
{{/models}} {{/models}}
## Authorization ## Authorization
{{^authMethods}} {{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
All endpoints do not require authorization. {{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
{{/authMethods}}
{{#authMethods}} {{#authMethods}}
{{#last}} Authentication schemes defined for the API:{{/last}}
### {{{name}}} ### {{{name}}}
{{#isApiKey}} {{#isApiKey}}

6
samples/client/petstore/php/OpenAPIClient-php/README.md
View File

@ -167,6 +167,7 @@ Class | Method | HTTP request | Description
## Authorization ## Authorization
Authentication schemes defined for the API:
### petstore_auth ### petstore_auth
- **Type**: `OAuth` - **Type**: `OAuth`
@ -176,7 +177,6 @@ Class | Method | HTTP request | Description
- **write:pets**: modify pets in your account - **write:pets**: modify pets in your account
- **read:pets**: read your pets - **read:pets**: read your pets
### api_key ### api_key
- **Type**: API key - **Type**: API key
@ -184,7 +184,6 @@ Class | Method | HTTP request | Description
- **Location**: HTTP header - **Location**: HTTP header
### api_key_query ### api_key_query
- **Type**: API key - **Type**: API key
@ -192,17 +191,14 @@ Class | Method | HTTP request | Description
- **Location**: URL query string - **Location**: URL query string
### http_basic_test ### http_basic_test
- **Type**: HTTP basic authentication - **Type**: HTTP basic authentication
### bearer_test ### bearer_test
- **Type**: Bearer authentication (JWT) - **Type**: Bearer authentication (JWT)
### http_signature_test ### http_signature_test
## Tests ## Tests

5
samples/server/petstore/php-symfony/SymfonyBundle-php/README.md
View File

@ -153,7 +153,8 @@ Class | Method | HTTP request | Description
## Documentation For Authorization ## Documentation For Authorization
## petstore_auth Authentication schemes defined for the API:
### petstore_auth
- **Type**: OAuth - **Type**: OAuth
- **Flow**: implicit - **Flow**: implicit
@ -162,7 +163,7 @@ Class | Method | HTTP request | Description
- **write:pets**: modify pets in your account - **write:pets**: modify pets in your account
- **read:pets**: read your pets - **read:pets**: read your pets
## api_key ### api_key
- **Type**: API key - **Type**: API key
- **API key parameter name**: api_key - **API key parameter name**: api_key